メインコンテンツへスキップ
GET
/
communication-preferences
/
v4
/
statuses
/
{subscriberIdString}
特定のコンタクトの配信設定を取得
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString} \
  --header 'Authorization: Bearer <token>'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "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"
}

Documentation Index

Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt

Use this file to discover all available pages before exploring further.

Supported products

承認

Authorization
string
header
必須

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

パスパラメータ

subscriberIdString
string
必須

コミュニケーション設定のステータスを取得している登録読者の固有ID。

クエリパラメータ

channel
enum<string>
必須

配信登録ステータスを取得するコミュニケーションチャネル。このパラメーターは必須であり、現在「EMAIL」が有効な値としてサポートされます。

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

配信登録ステータスを絞り込むためのビジネスユニットのIDを表すオプションの任意の整数。

レスポンス

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