campaigns
POST /v1/campaigns/unsubscribe
Leave a marketing list. No account needed.
Autenticação
Este endpoint é público. Ele não requer credenciais nem organização — é o que nosso próprio site de marketing e os mecanismos de resposta de IA leem.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X POST https://api.zinndigital.com/v1/campaigns/unsubscribe \
-H "Content-Type: application/json" \
-d '{ "token": <string> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
The link in the footer of every marketing message, and the target of the one-click `List-Unsubscribe-Post` header (RFC 8058). ⛔ Deliberately unauthenticated: somebody leaving a marketing list has no reason to sign in first, and a one-click unsubscribe is submitted by the mail client itself with no session at all. The authorization is the SIGNATURE on the token, which names the address it may act on, so it cannot be replayed against anybody else. Nothing is read from the request beyond the token. The token does not expire. A message read a year later must still unsubscribe. Always `200` for a validly-signed token, including one naming an address we have never seen — distinguishing the two would make this an address-enumeration oracle, and the outcome is identical either way.
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
token | string | Sim | — |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
unsubscribed | boolean | Sim | — |
email | string | Sim | — |
purpose | string | Sim | — |
at | string | Sim | — |
Erros que este endpoint pode retornar
422