Zum Hauptinhalt springen
POST
/
communication-preferences
/
v4
/
statuses
/
{subscriberIdString}
Abonnementstatus eines Kontakts aktualisierem
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "statusState": "SUBSCRIBED",
  "channel": "EMAIL",
  "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.read_write
communication_preferences.write

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

subscriberIdString
string
required

Die E-Mail-Adresse des Kontakts.

Body

application/json
statusState
enum<string>
required

Der aktuelle Abonnementstatus des Kontakts, mit den Optionen „SUBSCRIBED“, „UNSUBSCRIBED“ oder „NOT_SPECIFIED“.

Verfügbare Optionen:
SUBSCRIBED,
UNSUBSCRIBED,
NOT_SPECIFIED
channel
enum<string>
required

Die Art des Kommunikationskanals, wobei nur die Option „E-MAIL“ unterstützt wird.

Verfügbare Optionen:
EMAIL
subscriptionId
integer
required

Die eindeutige ID des zu aktualisierenden Abonnements.

Die rechtliche Grundlage für die Kommunikation, u. a. mit folgenden Optionen „LEGITIMATE_INTEREST_PQL“, „LEGITIMATE_INTEREST_CLIENT“, „PERFORMANCE_OF_CONTRACT“, „CONSENT_WITH_NOTICE“, „NON_GDPR“, „PROCESS_AND_STORE“ und „LEGITIMATE_INTEREST_OTHER“.

Verfügbare Optionen:
LEGITIMATE_INTEREST_PQL,
LEGITIMATE_INTEREST_CLIENT,
PERFORMANCE_OF_CONTRACT,
CONSENT_WITH_NOTICE,
NON_GDPR,
PROCESS_AND_STORE,
LEGITIMATE_INTEREST_OTHER

Eine Erläuterung der rechtlichen Grundlage für die Kommunikation.

Response

successful operation

completedAt
string<date-time>
required

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

startedAt
string<date-time>
required

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

results
object[]
required

Ein Array mit Ergebnissen aus dem Vorgang.

status
enum<string>
required

Zeigt den aktuellen Status des Vorgangs an, mit den möglichen Werten: AUSSTEHEND, WIRD VERARBEITET, STORNIERT, ABGESCHLOSSEN.

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

Die Anzahl der während des Vorgangs aufgetretenen Fehler.

requestedAt
string<date-time>

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

Enthält URLs mit Bezug zur Antwort, z. B. Dokumentation oder Ressourcen.

errors
object[]

Eine Liste der während des Vorgangs aufgetretenen Fehler.