Zum Hauptinhalt springen
POST
/
communication-preferences
/
v3
/
unsubscribe
Einen Kontakt von einem Abonnement abmelden
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v3/unsubscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emailAddress": "<string>",
  "subscriptionId": "<string>",
  "legalBasis": "CONSENT_WITH_NOTICE",
  "legalBasisExplanation": "<string>"
}
'
{
  "description": "<string>",
  "id": "<string>",
  "name": "<string>",
  "sourceOfStatus": "BRAND_WIDE_STATUS",
  "status": "NOT_SUBSCRIBED",
  "brandId": 123,
  "legalBasis": "CONSENT_WITH_NOTICE",
  "legalBasisExplanation": "<string>",
  "preferenceGroupName": "<string>"
}

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.

Body

application/json
​
emailAddress
string
required

Die E-Mail-Adresse des Kontakts.

​
subscriptionId
string
required

ID des aktualisierten Abonnements des Kontakts.

​
legalBasis
enum<string>

Rechtliche Grundlage für die Verarbeitung von Kontaktdaten zum Aktualisieren des Status des Kontakts (erforderlich für DSGVO-konforme Portale).

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

Eine ausführlichere Erläuterung zur rechtlichen Grundlage für die Verarbeitung von Kontaktdaten (erforderlich für DSGVO-konforme Portale).

Response

successful operation

​
description
string
required

Eine Beschreibung des Abonnements.

​
id
string
required

Die ID des Abonnements.

​
name
string
required

Der Name des Abonnements.

​
sourceOfStatus
enum<string>
required

Wo der Status z. B. aus PORTAL_WIDE_STATUS ermittelt wird, wenn der Kontakt sich aus dem Portal abgemeldet hat.

Verfügbare Optionen:
BRAND_WIDE_STATUS,
PORTAL_WIDE_STATUS,
SUBSCRIPTION_STATUS
​
status
enum<string>
required

Ob der Kontakt angemeldet ist.

Verfügbare Optionen:
NOT_SUBSCRIBED,
SUBSCRIBED
​
brandId
integer<int64>

Die ID der Marke, der das Abonnement zugeordnet ist, sofern vorhanden.

​
legalBasis
enum<string>

Die rechtliche Grundlage für den aktuellen Status des Abonnements.

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

Eine ausführlichere Erläuterung zur rechtlichen Grundlage für die Verarbeitung von Kontaktdaten.

​
preferenceGroupName
string

Der Name der Einstellungsgruppe, der das Abonnement zugeordnet ist.