Zum Hauptinhalt springen
GET
/
communication-preferences
/
2026-03
/
statuses
/
{subscriberIdString}
Abonnementeinstellungen für einen spezifischen Kontakt abrufen
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString} \
  --header 'Authorization: Bearer <token>'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "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>"
    }
  ],
  "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"
}

Supported products

Autorisierungen

Authorization
string
header
erforderlich

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

Pfadparameter

subscriberIdString
string
erforderlich

Die eindeutige Kennung des Abonnenten, dessen Status der Kommunikationseinstellungen abgerufen wird.

Abfrageparameter

channel
enum<string>
erforderlich

Eine erforderliche Zeichenfolge, die den Kommunikationskanal angibt, für den der Status abgerufen werden soll. Gültiger Wert ist „EMAIL“.

Verfügbare Optionen:
EMAIL
businessUnitId
integer<int64>

Eine optionale Ganzzahl, die die ID des Unternehmensbereichs darstellt, nach der der Abonnementstatus gefiltert werden soll.

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 Ergebnissen aus dem Vorgang.

startedAt
string<date-time>
erforderlich

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

status
enum<string>
erforderlich

Zeigt den aktuellen Status des Vorgangs an, mit den möglichen Werten: PENDING, PROCESSING, CANCELED, COMPLETE.

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

Eine Liste der während des Vorgangs aufgetretenen Fehler.

Enthält URLs im Zusammenhang mit der Antwort, z. B. Dokumentation oder Ressourcen.

numErrors
integer<int32>

Die Anzahl der während des Vorgangs aufgetretenen Fehler.

requestedAt
string<date-time>

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

Last modified on April 13, 2026