Skip to the documentation
API

Keep subscriptions

What Keep does on the Subscriptions page.

POST/subscriptions/batch-keep

Runs the real call on your workspace.

POST /subscriptions/batch-keep

What Keep does on the Subscriptions page.

Example

Needs threads:write. ids takes 1 to 100 subscriptions. Each active one moves to kept, is never suggested again and is left alone when you unsubscribe from its whole domain. kept: false puts kept ones back to active.

curl
curl -X POST "$OE/subscriptions/batch-keep" -H "$AUTH" \  -H "Content-Type: application/json" -d '{ "ids": ["sub_5d2c8e17", "sub_9a41f03b"] }'
Response
{  "object": "subscription_batch_keep",  "kept": true,  "updated": ["sub_5d2c8e17"],  "skipped": ["sub_9a41f03b"],  "missing": []}

updated holds the subscriptions that changed. One already in that state, or one you unsubscribed from, comes back in skipped, and an id that is unknown or delivered to an address the key does not reach in missing.

Reference