Zum Hauptinhalt springen
POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
unsubscribe-all
Kontakte von allen Abonnements massenweise abmelden
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/batch/unsubscribe-all \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --data '{
  "inputs": [
    "<string>"
  ]
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "subscriberIdString": "<string>",
      "statuses": [
        {
          "subscriptionName": "<string>",
          "channel": "EMAIL",
          "subscriberIdString": "<string>",
          "legalBasis": "LEGITIMATE_INTEREST_PQL",
          "setStatusSuccessReason": "RESUBSCRIBE_OCCURRED",
          "source": "<string>",
          "subscriptionId": 123,
          "legalBasisExplanation": "<string>",
          "businessUnitId": 123,
          "status": "SUBSCRIBED",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "errors": [
    {
      "subCategory": {},
      "context": {},
      "links": {},
      "id": "<string>",
      "category": "<string>",
      "message": "<string>",
      "errors": [
        {
          "subCategory": "<string>",
          "code": "<string>",
          "in": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "message": "<string>"
        }
      ],
      "status": "<string>"
    }
  ],
  "status": "PENDING"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Kostenlos
Diese API erfordert einen der folgenden Bereiche:
communication_preferences.statuses.batch.write

Authorizations

private-app
string
header
required

Query Parameters

businessUnitId
integer

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
default:false

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

channel
enum<string>
required

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

Verfügbare Optionen:
EMAIL

Body

application/json
inputs
string[]
required

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

Response

successful operation

completedAt
string<date-time>
required

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

startedAt
string<date-time>
required

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

results
object[]
required

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

status
enum<string>
required

Der aktuelle Status des Opt-out-Massenvorgangs: AUSSTEHEND, WIRD VERARBEITET, STORNIERT oder ABGESCHLOSSEN.

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

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.

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

errors
object[]

Ein Array von Fehlerobjekten mit Details zu Problemen, die während des Opt-out-Massenvorgangs aufgetreten sind.