メインコンテンツへスキップ
GET
/
communication-preferences
/
v4
/
statuses
/
{subscriberIdString}
/
unsubscribe-all
コンタクトの配信停止ステータスを取得
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString}/unsubscribe-all \
  --header 'Authorization: Bearer <token>'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "channel": "EMAIL",
      "status": "NOT_SPECIFIED",
      "subscriberIdString": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "wideStatusType": "BUSINESS_UNIT_WIDE",
      "businessUnitId": 123
    }
  ],
  "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。これは任意の整数パラメーターです。

verbose
boolean
デフォルト:false

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

レスポンス

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