Unsubscribe
Unsubscribe from product email or account reminders with the link from a Syntext email — one-click or from a page.
Turns product email or account reminders off for the person an unsubscribe link belongs to. It accepts two kinds of request:
POST with the token in the query string when you press their Unsubscribe button (RFC 8058). Every product email and account reminder carries this link in its List-Unsubscribe header.This endpoint only ever turns email off. To turn something back on, use Update Email Preferences.
Public — no credential needed. The signed token in the email's link is the credential. Rate limited to 30 requests a minute per IP address, shared with Get Unsubscribe Link.
Query Parameters
tokentoken takes precedence over it.Request Body
Read only when Content-Type is application/json. Any other body, such as a one-click form, is ignored.
tokencategoriesproduct_tips, account_nudges, reports, news and account (account reminders), at most five.alltrue unsubscribes from all product email and account reminders.What gets turned off
| Request | Turns off |
|---|---|
all: true | Every category, account included, and marketing consent is withdrawn |
categories with at least one entry | Those categories |
| Neither — including one-click | What the link was for: its one category, or everything if the link was for all |
Unsubscribing from everything stops product email and account reminders only. Invitations, deprecation notices, stale-page alerts, build, billing and security email are still sent — see Email from Syntext.
Response — 200 OK
The link's state after the change, in the same shape as Get Unsubscribe Link:
Error Responses
400 Bad Request
invalid_token — the token is missing, altered, or belongs to an account that no longer exists.
validation_error — a JSON body that isn't valid: an unknown category, more than five categories, or all that isn't a boolean.
429 Too Many Requests
rate_limited — more than 30 requests in a minute from one IP address. Try again in a minute.
503 Service Unavailable
not_configured — unsubscribe links aren't available right now.