Leave the mailing list

Server URLloading...

POST

/v1/unsubscribe

Send

Authorization

Body

Stops product announcements to one address. No credentials: the token is the authority, and it is the one carried by the unsubscribe link in the footer of every message.

Idempotent, and it works for an address the mail provider has never seen - the opt-out is recorded either way, so it survives that address being added to a list later.

POST rather than GET on purpose. Mail clients and scanners fetch the URLs in a message before anybody reads it, and an unsubscribe that happened on GET would fire for every one of them. This is also what List-Unsubscribe-Post advertises, so a one-click unsubscribe in the inbox reaches exactly this endpoint.

Sign-in links are not affected. They are not mail anybody subscribes to - without them there is no way into the account at all.

Response Body

curl -X POST "https://example.com/v1/unsubscribe" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "token": "string"  }'

{  "subscribed": true}