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

ドメイン全体の購読を解除する

1 つのドメインのすべての送信者を一度に対象にします。「購読」ページのドメイン表示と同じです。

POST/subscriptions/domains/{domain}/unsubscribe

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

POST /subscriptions/domains/{domain}/unsubscribe

1 つのドメインのすべての送信者を一度に対象にします。「購読」ページのドメイン表示と同じです。

例

threads:write が必要です。ドメイン内で、ワンクリックのリクエストか購読解除のメールを受け付けるすべての送信者の購読を解除します。bin: true を指定するとそれらの会話もゴミ箱に移し、address を指定すると 1 つのアドレスに届く購読だけを対象にします。

curl
curl -X POST "$OE/subscriptions/domains/figma.com/unsubscribe" -H "$AUTH"
レスポンス
{  "object": "domain_unsubscribe",  "domain": "figma.com",  "unsubscribed": 2,  "skipped": 1,  "failed": 0,  "binned": 0}

skipped は、人が開く必要のあるページしか用意していない送信者を数え、failed はリクエストを受け付けなかった送信者を数えます。どちらもそのまま残ります。

リファレンス