メインコンテンツへスキップ
POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
read
ステータスをバッチ読み取り
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    "<string>"
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "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>"
        }
      ],
      "subscriberIdString": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "links": {},
  "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。整数です。

ボディ

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

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

requestedAt
string<date-time>

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

Last modified on April 13, 2026