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"
}
}Unsubscribe
Switches one category off for the contact the token names — the act behind the link, and the endpoint List-Unsubscribe-Post points at.
Idempotent, and it has to be. The two callers that reach it in practice are a mail client performing RFC 8058’s one-click unsubscribe on the reader’s behalf and then the reader clicking the same link; the write is an upsert and the token is not spent, so both end in the same place.
A body is optional. Sending {"opted_out": false} turns the category back on, which is what an “actually, I clicked by mistake” button on the page posts. A body that is not JSON is ignored rather than refused — the one-click client posts a form body, and refusing it would break the control exactly when nobody is there to read the error.
It never affects transactional mail. There is no category that could.
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.
Corpo
false turns the category back on.
Resposta
The decision as it now stands.
marketing, product_news, surveys 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