ドキュメント本文へスキップ
API

送信者の購読を解除する

「購読」ページの「購読を解除」ボタンと同じ動作。

POST/subscriptions/{id}/unsubscribe

実際の呼び出しをワークスペースに対して実行します。

POST /subscriptions/{id}/unsubscribe

「購読」ページの「購読を解除」ボタンと同じ動作。

例

threads:write が必要です。送信者が求める方法で購読を解除します。ワンクリックのリクエストが用意されていればそれを使い、なければメールが届いたアドレスから購読解除のメールを送ります。bin: true を指定すると、その送信者からの会話もすべてゴミ箱に移します。ボディは省略できます。

curl
curl -X POST "$OE/subscriptions/sub_5d2c8e17/unsubscribe" -H "$AUTH" \  -H "Content-Type: application/json" -d '{ "bin": true }'
レスポンス
{  "object": "unsubscribe",  "subscriptionId": "sub_5d2c8e17",  "method": "one-click",  "url": null,  "binned": 58}

ページしか用意していない送信者の場合、応答の method は link になり、url にそのページが入ります。このページは人が開く必要があります。

購読を解除する手段がない送信者は 422 unsubscribe_unsupported になり、ワンクリックのリクエストを受け付けず、メールを送れるアドレスも示していない送信者は 502 unsubscribe_refused になります。どちらの場合も何も変わっていません。

リファレンス