A valid request URL is required to generate request examples{
"category": "marketing",
"category_label": "<string>",
"organization": "<string>",
"opted_out": true,
"locale": "pt-BR"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}What this link will switch off
The read behind an unsubscribe page: which category the link stops, and whose product it belongs to.
A read, never the act. Mail gateways and security scanners fetch every link in a message before a person sees it, so a GET that unsubscribed would unsubscribe people who never clicked. POST is the act.
It needs no credential of any kind — the token in the path is the whole of it. That is the requirement rather than a gap: the reader clicked from an inbox on a device they are not signed in on, and a descadastro that first asks them to remember a password is a descadastro that fails, whose next step is the spam button. The token never expires and is never spent, for the same reason.
It says which category and which tenant, and deliberately never the address it was sent to: a token out of a forwarded email must not become a lookup of whose inbox it came from.
A valid request URL is required to generate request examples{
"category": "marketing",
"category_label": "<string>",
"organization": "<string>",
"opted_out": true,
"locale": "pt-BR"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Parâmetros de caminho
The uk_ns_… token from the link.
Resposta
What the page renders.
marketing, product_news, surveys The category as a person reads it.
Whose product this mail is from. Empty when it cannot be resolved — the link still works.
Whether this contact has already switched this category off.
Which language to draw the page in, resolved from the TOKEN rather than from the request — the contact's own, then the environment's default. It is the same answer the footer link this person clicked was written in, which is the point: the page has no tenant to ask, and one that guessed from the browser would disagree with the email.
pt-BR, en