campaigns
POST /v1/campaigns/unsubscribe
Leave a marketing list. No account needed.
Аутентификация
Этот эндпоинт является публичным. Он не требует учетных данных и организации — его читают наш собственный маркетинговый сайт и поисковые системы на базе ИИ.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X POST https://api.zinndigital.com/v1/campaigns/unsubscribe \
-H "Content-Type: application/json" \
-d '{ "token": <string> }'Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
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.
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
token | string | Да | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
unsubscribed | boolean | Да | — |
email | string | Да | — |
purpose | string | Да | — |
at | string | Да | — |
Ошибки, которые может возвращать этот эндпоинт
422