/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get Unsubscribe Link

Get Unsubscribe Link

Look up what an unsubscribe link from a Syntext email covers.

GET/v1/email/unsubscribeTry it
Session token

Returns what an unsubscribe link applies to and the person's current categories, so an unsubscribe page can show them before anything changes. Nothing is changed by this call.

Note

Public — no credential needed. The signed token in the email's link is the credential, and it names the person. Rate limited to 30 requests a minute per IP address, shared with Unsubscribe.

Unsubscribe tokens don't expire, so a link in an old email keeps working.

Query Parameters

NameDescription
token:stringqueryRequired
The token from the unsubscribe link in the email.

Response — 200 OK

NameDescription
email:stringbody
The address, masked to its first character and domain — enough to recognise, not to harvest.
scope:stringbody
What the link was for: one category (product_tips, account_nudges, reports, news or account), or all. An account reminder's link is for account.
categories:objectbody
One boolean per category — the four product email categories and account (account reminders) — true when the person still gets it.
unsubscribedAll:booleanbody
true when the person has already unsubscribed from all — product email and account reminders.

Error Responses

400 Bad Request

invalid_token — the token is missing, altered, or belongs to an account that no longer exists.

json
{
"error": {
"code": "invalid_token",
"message": "This unsubscribe link is not valid.",
"details": { "traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10" }
}
}

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.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl "https://api.syntext.dev/v1/email/unsubscribe?token=$UNSUBSCRIBE_TOKEN"
Responseapplication/json
200OK
{
"data": {
"email": "a***@example.com",
"scope": "reports",
"categories": {
"product_tips": true,
"account_nudges": true,
"reports": true,
"news": true,
"account": true
},
"unsubscribedAll": false
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext