Zum Hauptinhalt springen
GET
/
communication-preferences
/
v4
/
statuses
/
{subscriberIdString}
/
unsubscribe-all
„Abgemeldet“-Status eines Kontakts abrufen
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString}/unsubscribe-all \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

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.

Pfadparameter

subscriberIdString
string
erforderlich

Die E-Mail-Adresse des Kontakts.

Abfrageparameter

channel
enum<string>
erforderlich

Der Kanaltyp für den Abonnementtyp. Derzeit wird nur „E-MAIL“ unterstützt.

Verfügbare Optionen:
EMAIL
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“.

verbose
boolean
Standard:false

Wird auf „wahr“ gesetzt, um die Details der aktualisierten Abonnementstatus in der Antwort einzuschließen. Wenn Sie diesen Parameter nicht angeben, erhalten Sie eine leere Antwort.

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

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

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 March 24, 2026