Zum Hauptinhalt springen
POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
write
Abonnementstatus batchweise aktualisieren
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/batch/write \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --data '{
  "inputs": [
    {
      "statusState": "SUBSCRIBED",
      "channel": "EMAIL",
      "subscriberIdString": "<string>",
      "legalBasis": "LEGITIMATE_INTEREST_PQL",
      "subscriptionId": 123,
      "legalBasisExplanation": "<string>"
    }
  ]
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "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

Body

application/json
inputs
object[]
required

Response

successful operation

completedAt
string<date-time>
required

Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Vorgang abgeschlossen wurde.

startedAt
string<date-time>
required

Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Vorgang gestartet wurde.

results
object[]
required

Ein Array mit den Ergebnissen aus dem Batch-Vorgang.

status
enum<string>
required

Der aktuelle Status des Batch-Vorgangs: AUSSTEHEND, WIRD VERARBEITET, STORNIERT oder ABGESCHLOSSEN.

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

Die Anzahl der während des Batch-Vorgangs aufgetretenen Fehler.

requestedAt
string<date-time>

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

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

errors
object[]

Ein Array von Fehlerobjekten mit Details zu den aufgetretenen Problemen.