Skip to the documentation
API

Move what several senders sent

What Archive does on a selection of the Subscriptions page.

POST/subscriptions/batch-move

Runs the real call on your workspace.

POST /subscriptions/batch-move

What Archive does on a selection of the Subscriptions page.

Example

Needs threads:write. ids takes 1 to 100 subscriptions, and every conversation from each one moves to destination, as POST /subscriptions/{id}/move does for one. With future, true unless you say otherwise, a rule per sender keeps doing it to new mail.

curl
curl -X POST "$OE/subscriptions/batch-move" -H "$AUTH" \  -H "Content-Type: application/json" -d '{ "ids": ["sub_5d2c8e17", "sub_9a41f03b"], "destination": "archive", "future": false }'
Response
{  "object": "subscription_batch_move",  "moved": 73,  "updated": ["sub_5d2c8e17", "sub_9a41f03b"],  "failed": [],  "missing": []}

moved counts the conversations moved across every sender. Keeping it going needs rules:write too, so a key without it passes future: false.

Reference