メインコンテンツへスキップ
POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
unsubscribe-all
コンタクトの全ての配信をバッチで停止
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/batch/unsubscribe-all \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    "<string>"
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "subscriberIdString": "<string>",
      "statuses": [
        {
          "channel": "EMAIL",
          "source": "<string>",
          "status": "NOT_SPECIFIED",
          "subscriberIdString": "<string>",
          "subscriptionId": 123,
          "timestamp": "2023-11-07T05:31:56Z",
          "businessUnitId": 123,
          "legalBasis": "CONSENT_WITH_NOTICE",
          "legalBasisExplanation": "<string>",
          "setStatusSuccessReason": "NO_STATUS_CHANGE",
          "subscriptionName": "<string>"
        }
      ]
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

クエリパラメータ

channel
enum<string>
必須

配信停止するコミュニケーションチャネル。このパラメーターは必須であり、「EMAIL」である必要があります。

利用可能なオプション:
EMAIL
businessUnitId
integer<int64>

処理が適用されるビジネスユニットのID。これは任意のパラメーターです。

verbose
boolean
デフォルト:false

レスポンスに詳細な処理情報を含めるかどうかを示すブール値。デフォルトはfalseです。

ボディ

application/json
inputs
string[]
必須

バッチ処理の入力を表す文字列のリスト。

レスポンス

successful operation

completedAt
string<date-time>
必須

一括オプトアウト処理が完了した日時。

results
object[]
必須

全てのコミュニケーション処理からの一括オプトアウトの結果を含む配列。

startedAt
string<date-time>
必須

一括オプトアウト処理が始まった日時。

status
enum<string>
必須

一括オプトアウト処理の現在のステータス(PENDING、PROCESSING、CANCELED、COMPLETEを取り得る)。

利用可能なオプション:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

一括オプトアウト処理中に発生した問題について詳述するエラーオブジェクトの配列。

関連するリソースやドキュメントにリンクしているURLのコレクション。

numErrors
integer<int32>

一括オプトアウト中に発生したエラー数の合計。

requestedAt
string<date-time>

一括オプトアウトのリクエストが行われた日時。

Last modified on April 13, 2026