コンタクトの配信停止ステータスを取得
ステータス
Retrieve a contact's unsubscribed status
コンタクトが全てのEメールの配信を停止したかどうかを確認します。コンタクトが全てのコミュニケーションからオプトアウトしていない場合、応答の「結果」列は空になります。
GET
コンタクトの配信停止ステータスを取得
Supported products
Supported products
Required Scopes
Required Scopes
承認
The access token received from the authorization server in the OAuth 2.0 flow.
パスパラメータ
全てのコミュニケーション設定から配信停止する登録読者の固有ID。
クエリパラメータ
登録読者の配信を停止するコミュニケーションチャネル。これは必須のパラメーターであり、「EMAIL」である必要があります。
利用可能なオプション:
EMAIL 登録読者が属するビジネスユニットのID。これは任意のパラメーターです。
レスポンスに詳細情報を含めるかどうかを示すブール値。デフォルトはfalseです。
レスポンス
successful operation
処理が完了した日時。
処理の結果が格納される配列。
処理が開始された日時。
処理の現在のステータス(PENDING、PROCESSING、CANCELED、COMPLETEを取り得る)。
利用可能なオプション:
CANCELED, COMPLETE, PENDING, PROCESSING 処理中に発生した問題について詳述するエラーオブジェクトの配列。
関連リンクを含むオブジェクト(各キーはリンク名で、各値はURLです)。
処理中に発生したエラーの数。
リクエストが行われた日時。
最終更新日 2026年5月11日