Zum Hauptinhalt springen
POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
unsubscribe-all
/
read
Kontakte, die sich von sämtlicher Kommunikation abgemeldet haben, batchweise abrufen
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/batch/unsubscribe-all/read \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --data '{
  "inputs": [
    "<string>"
  ]
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "wideStatuses": [
        {
          "wideStatusType": "PORTAL_WIDE",
          "subscriberIdString": "<string>",
          "channel": "EMAIL",
          "businessUnitId": 123,
          "status": "SUBSCRIBED",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "subscriberIdString": "<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.read

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“.

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 Batch-Prozess abgeschlossen wurde.

startedAt
string<date-time>
required

Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Prozess begann.

results
object[]
required

Das Array der Ergebnisse aus dem Batch-Prozess, die jeweils Informationen zum Abonnementstatus enthalten.

status
enum<string>
required

Der aktuelle Status des Batch-Prozesses mit den möglichen Werten: AUSSTEHEND, WIRD VERARBEITET, STORNIERT, ABGESCHLOSSEN.

Verfügbare Optionen:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
requestedAt
string<date-time>

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

Eine Sammlung von zugehörigen Links, die der Batch-Antwort zugeordnet sind.