Retrieve a contact's unsubscribed status

Überprüft, ob ein Kontakt sich von allen E-Mail-Abonnements abgemeldet hat. Wenn sich ein Kontakt nicht von sämtlicher Kommunikation abgemeldet hat, ist das „results“-Array leer.

GET /communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all

„Abgemeldet“-Status eines Kontakts abrufen

cURL

curl --request GET \
  --url https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all \
  --header 'Authorization: Bearer <token>'

200

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "channel": "EMAIL",
      "status": "NOT_SPECIFIED",
      "subscriberIdString": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "wideStatusType": "BUSINESS_UNIT_WIDE",
      "businessUnitId": 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"
}

Supported products

Required Scopes

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 ID des Abonnenten, der von allen Kommunikationseinstellungen abgemeldet werden soll.

Abfrageparameter

channel · enum<string> · erforderlich

Der Kommunikationskanal, von dem der Abonnent abgemeldet werden soll. Dieser Parameter ist erforderlich und muss „EMAIL“ sein.

Verfügbare Optionen: EMAIL

businessUnitId · integer<int64>

Die ID des Unternehmensbereichs, zu dem der Abonnent gehört. Dies ist ein optionaler Parameter.

verbose · boolean · Standard: false

Ein boolescher Wert, der angibt, ob detaillierte Informationen in die Antwort aufgenommen werden sollen. Der Standardwert ist „false“.

Antwort

200

application/json

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.

Show child attributes

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 von Fehlerobjekten mit Details zu Problemen, die während des Vorgangs aufgetreten sind.

Show child attributes

links · object

Ein Objekt mit zugehörigen Links, wobei jeder Schlüssel ein Link-Name und jeder Wert eine URL ist.

Show child attributes

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.