Batch retrieve subscription statuses

Rufen Sie die Abonnementstatus für eine Reihe von Kontakten batchweise ab.

POST /communication-preferences/2026-03/statuses/batch/read

Abonnementstatus batchweise abrufen

cURL

curl --request POST \
  --url https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    "<string>"
  ]
}
'

200

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "statuses": [
        {
          "channel": "EMAIL",
          "source": "<string>",
          "status": "NOT_SPECIFIED",
          "subscriberIdString": "<string>",
          "subscriptionId": 123,
          "timestamp": "2023-11-07T05:31:56Z",
          "businessUnitId": 123,
          "legalBasis": "CONSENT_WITH_NOTICE",
          "legalBasisExplanation": "<string>",
          "setStatusSuccessReason": "NO_STATUS_CHANGE",
          "subscriptionName": "<string>"
        }
      ],
      "subscriberIdString": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

Required Scopes

Autorisierungen

Authorization · string · header · erforderlich

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

Abfrageparameter

channel · enum<string> · erforderlich

Der Kommunikationskanal zum Filtern der Abonnementstatus. Muss „EMAIL“ sein.

Verfügbare Optionen: EMAIL

businessUnitId · integer<int64>

Eine optionale Ganzzahl, die die ID des Unternehmensbereichs darstellt. Dieser Parameter hilft, die Ergebnisse basierend auf dem spezifischen Unternehmensbereich zu filtern.

Body

application/json

inputs · string[] · erforderlich

Eine Liste von Zeichenfolgen, die für die Eingaben von Batch-Vorgängen stehen.

Antwort

200

application/json

successful operation

completedAt · string<date-time> · erforderlich

Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Prozess abgeschlossen wurde.

results · object[] · erforderlich

Das Array der Ergebnisse aus dem Batch-Prozess, die jeweils Informationen zum Abonnementstatus enthalten.

Show child attributes

startedAt · string<date-time> · erforderlich

Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Prozess begann.

status · enum<string> · erforderlich

Der aktuelle Status des Batch-Prozesses mit den möglichen Werten: PENDING, PROCESSING, CANCELED oder COMPLETE.

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

links · object

Eine Sammlung von zugehörigen Links, die der Batch-Antwort zugeordnet sind.

Show child attributes

requestedAt · string<date-time>

Der Zeitpunkt (Datum und Uhrzeit), zu dem die Batch-Anfrage gestellt wurde.