Zum Hauptinhalt springen
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.

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>

処理がリクエストされた日時。

処理に関連付けられた関連リンクのコレクション。

errors
object[]

処理中に発生したエラーの配列。