Zum Hauptinhalt springen
POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
unsubscribe-all
/
read
全てのコミュニケーションからオプトアウトしたコンタクトを一括で取得
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/batch/unsubscribe-all/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "inputs": [
    "<string>"
  ]
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "wideStatuses": [
        {
          "wideStatusType": "PORTAL_WIDE",
          "subscriberIdString": "<string>",
          "channel": "EMAIL",
          "businessUnitId": 123,
          "status": "SUBSCRIBED",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "subscriberIdString": "<string>"
    }
  ],
  "status": "PENDING"
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -無料ツール
この API には、次のいずれかのスコープが必要です。
communication_preferences.statuses.batch.read

Authorizations

Authorization
string
header
required

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

Query Parameters

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
requestedAt
string<date-time>

バッチリクエストが行われた日時。

バッチレスポンスに関連付けられた関連リンクのコレクション。