Zum Hauptinhalt springen
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",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "wideStatusType": "PORTAL_WIDE",
      "subscriberIdString": "<string>",
      "channel": "EMAIL",
      "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.read
communication_preferences.read_write

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
subscriberIdString
string
required

コンタクトのEメールアドレス。

Query Parameters

​
businessUnitId
integer

［ビジネスユニット追加オプション］（https://developers.hubspot.com/beta-docs/guides/api/settings/business-units-api）をご利用の場合は、ビジネスユニットIDで結果を絞り込めるようにこのパラメーターを含めてください。デフォルトのアカウントのビジネスユニットでは常に「0」が使用されます。

​
verbose
boolean
default:false

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

​
channel
enum<string>
required

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

Verfügbare Optionen:
EMAIL

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>

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

​
links
object

関連リンクを含むオブジェクト（各キーはリンク名で、各値はURLです）。

​
errors
object[]

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