campaigns
POST /v1/campaigns/unsubscribe
Leave a marketing list. No account needed.
認証
このエンドポイントは公開されています。認証情報や組織情報は不要で、当社のマーケティングサイトやAI回答エンジンが読み取っているものと同じです。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/campaigns/unsubscribe \
-H "Content-Type: application/json" \
-d '{ "token": <string> }'ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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