Zum Hauptinhalt springen
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",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "subscriberIdString": "<string>",
      "statuses": [
        {
          "subscriptionName": "<string>",
          "channel": "EMAIL",
          "subscriberIdString": "<string>",
          "legalBasis": "LEGITIMATE_INTEREST_PQL",
          "setStatusSuccessReason": "RESUBSCRIBE_OCCURRED",
          "source": "<string>",
          "subscriptionId": 123,
          "legalBasisExplanation": "<string>",
          "businessUnitId": 123,
          "status": "SUBSCRIBED",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "errors": [
    {
      "subCategory": "",
      "context": "",
      "links": "",
      "id": "",
      "category": "",
      "message": "",
      "errors": "",
      "status": ""
    }
  ],
  "status": "PENDING"
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -無料ツール
この API には、次のいずれかのスコープが必要です。
communication_preferences.statuses.batch.write

Authorizations

Authorization
string
header
required

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

Query Parameters

verbose
boolean
default:false

応答に更新された配信登録ステータスの詳細を含めるには「true」に設定します。このパラメーターを含めていないと、空の応答になります。

channel
enum<string>
required

配信カテゴリーのチャネルタイプ。現在のところ、サポートされているチャネルタイプは「EMAIL」のみです。

Verfügbare Optionen:
EMAIL

Body

application/json
inputs
string[]
required

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

Response

successful operation

completedAt
string<date-time>
required

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

startedAt
string<date-time>
required

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

results
object[]
required

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

status
enum<string>
required

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

Verfügbare Optionen:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
numErrors
integer

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

requestedAt
string<date-time>

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

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

errors
object[]

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