Batch unsubscribe contacts from all subscriptions

Melden Sie eine Reihe von Kontakten von allen E-Mail-Abonnements ab.

POST /communication-preferences/2026-03/statuses/batch/unsubscribe-all

Kontakte von allen Abonnements massenweise abmelden

cURL

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

200

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "subscriberIdString": "<string>",
      "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>"
        }
      ]
    }
  ],
  "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.

Abfrageparameter

channel · enum<string> · erforderlich

Der Kommunikationskanal, über den Abonnenten abgemeldet werden. Dieser Parameter ist erforderlich und unterstützt derzeit nur „EMAIL“.

Verfügbare Optionen: EMAIL

businessUnitId · integer<int64>

Eine optionale Ganzzahl, die die ID des Unternehmensbereichs darstellt, für die der Vorgang ausgeführt wird.

verbose · boolean · Standard: false

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

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 Opt-out-Massenvorgang abgeschlossen wurde.

results · object[] · erforderlich

Ein Array mit den Ergebnissen aus dem Opt-out-Massenvorgang von allen Kommunikationen.

Show child attributes

startedAt · string<date-time> · erforderlich

Der Zeitpunkt (Datum und Uhrzeit), zu dem der Opt-out-Massenvorgang begann.

status · enum<string> · erforderlich

Der aktuelle Status des Opt-out-Massenvorgangs: 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 Opt-out-Massenvorgangs aufgetreten sind.

Show child attributes

links · object

Eine Sammlung von URLs, die mit zugehörigen Ressourcen oder Dokumentationen verknüpft sind.

Show child attributes

numErrors · integer<int32>

Die Gesamtanzahl der während des Opt-out-Massenvorgangs aufgetretenen Fehler.

requestedAt · string<date-time>

Der Zeitpunkt (Datum und Uhrzeit), zu dem die Opt-out-Massenanfrage gestellt wurde.