Zum Hauptinhalt springen
GET
/
communication-preferences
/
v4
/
definitions
Alle Abonnementstatusdefinitionen abrufen
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v4/definitions \
  --header 'private-app: <api-key>'
{
  "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": "<string>",
      "category": "<string>",
      "message": "<string>",
      "errors": [
        {
          "subCategory": "<string>",
          "code": "<string>",
          "in": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "message": "<string>"
        }
      ],
      "status": "<string>"
    }
  ],
  "status": "PENDING"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Kostenlos
Diese API erfordert einen der folgenden Bereiche:
communication_preferences.read
communication_preferences.read_write

Authorizations

private-app
string
header
required

Query Parameters

businessUnitId
integer

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.

Response

successful operation

completedAt
string<date-time>
required

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

startedAt
string<date-time>
required

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

results
object[]
required

Ein Array mit den Ergebnissen aus dem Vorgang.

status
enum<string>
required

Der aktuelle Status des Vorgangs: AUSSTEHEND, WIRD VERARBEITET, STORNIERT oder ABGESCHLOSSEN.

Verfügbare Optionen:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
numErrors
integer

Die Anzahl der während des Vorgangs aufgetretenen Fehler.

requestedAt
string<date-time>

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

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

errors
object[]

Ein Array der während des Vorgangs aufgetretenen Fehler.