Zum Hauptinhalt springen
GET
/
communication-preferences
/
v4
/
definitions
Alle Abonnementstatusdefinitionen abrufen
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v4/definitions \
  --header 'Authorization: Bearer <token>'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "isActive": true,
      "isDefault": true,
      "isInternal": true,
      "name": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "businessUnitId": 123,
      "communicationMethod": "<string>",
      "purpose": "<string>",
      "subscriptionTranslations": [
        {
          "createdAt": 123,
          "description": "<string>",
          "languageCode": "<string>",
          "name": "<string>",
          "subscriptionId": 123,
          "updatedAt": 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"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Starter
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Kostenlos

Autorisierungen

Authorization
string
header
erforderlich

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

Abfrageparameter

businessUnitId
integer<int64>

Wenn Sie das Add-on für Unternehmensbereiche haben, können Sie diesen Parameter einschließen, um die Ergebnisse nach der Unternehmensbereich-ID zu filtern. Der Standardunternehmensbereich des Accounts verwendet immer „0“.

includeTranslations
boolean

Wird auf „wahr“ festgelegt, um Abonnementübersetzungen, die mit den einzelnen Definitionen verknüpft sind, zurückzugeben.

Antwort

successful operation

completedAt
string<date-time>
erforderlich

Der Zeitpunkt (Datum und Uhrzeit), zu dem der Vorgang abgeschlossen wurde.

results
object[]
erforderlich

Ein Array mit den Ergebnissen aus dem Vorgang.

startedAt
string<date-time>
erforderlich

Der Zeitpunkt (Datum und Uhrzeit), zu dem der Vorgang gestartet wurde.

status
enum<string>
erforderlich

Der aktuelle Status des Vorgangs: PENDING, PROCESSING, CANCELED oder COMPLETE.

Verfügbare Optionen:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

Ein Array der während des Vorgangs aufgetretenen Fehler.

Eine Sammlung von zugehörigen Links, die dem Vorgang zugeordnet sind.

numErrors
integer<int32>

Die Anzahl der während des Vorgangs aufgetretenen Fehler.

requestedAt
string<date-time>

Der Zeitpunkt (Datum und Uhrzeit), zu dem der Vorgang angefordert wurde.

Last modified on March 24, 2026