GET
/
communication-preferences
/
v4
/
definitions
全ての配信登録ステータス定義を取得
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v4/definitions \
  --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": [
    {
      "isInternal": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "isDefault": true,
      "communicationMethod": "<string>",
      "purpose": "<string>",
      "name": "<string>",
      "description": "<string>",
      "id": "<string>",
      "isActive": true,
      "businessUnitId": 123,
      "subscriptionTranslations": [
        {
          "createdAt": 123,
          "name": "<string>",
          "description": "<string>",
          "subscriptionId": 123,
          "languageCode": "<string>",
          "updatedAt": 123
        }
      ],
      "updatedAt": "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.

Query Parameters

includeTranslations
boolean

各定義に関連付けられた配信登録の翻訳を返すには「true」に設定します。

Response

successful operation

The response is of type object.