Skip to the documentation
API

Unsubscribe from a whole domain

Every sender on one domain at once, as the domain view of the Subscriptions page does.

POST/subscriptions/domains/{domain}/unsubscribe

Runs the real call on your workspace.

POST /subscriptions/domains/{domain}/unsubscribe

Every sender on one domain at once, as the domain view of the Subscriptions page does.

Example

Needs threads:write. It unsubscribes from every sender on the domain that takes a one-click request or an unsubscribe email. bin: true also moves their conversations to the Bin, and address keeps it to the subscriptions delivered to one address.

curl
curl -X POST "$OE/subscriptions/domains/figma.com/unsubscribe" -H "$AUTH"
Response
{  "object": "domain_unsubscribe",  "domain": "figma.com",  "unsubscribed": 2,  "skipped": 1,  "failed": 0,  "binned": 0}

skipped counts the senders that only offer a page, which a person has to open, and failed the ones that did not accept the request. Both are left as they were.

Reference