Zum Hauptinhalt springen
POST
/
communication-preferences
/
v3
/
unsubscribe
Désabonner un contact
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v3/unsubscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "emailAddress": "<string>",
  "legalBasis": "LEGITIMATE_INTEREST_PQL",
  "subscriptionId": "<string>",
  "legalBasisExplanation": "<string>"
}'
{
  "brandId": 123,
  "name": "<string>",
  "description": "<string>",
  "legalBasis": "LEGITIMATE_INTEREST_PQL",
  "preferenceGroupName": "<string>",
  "id": "<string>",
  "legalBasisExplanation": "<string>",
  "status": "SUBSCRIBED",
  "sourceOfStatus": "PORTAL_WIDE_STATUS"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit
Cette API requiert l'une des portées suivantes :
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

Adresses e-mail du contact

​
subscriptionId
string
required

ID de l'abonnement mis à jour pour le contact.

​
legalBasis
enum<string>

Base juridique pour la mise à jour du statut du contact (obligatoire pour les portails activés par le RGPD).

Available options:
LEGITIMATE_INTEREST_PQL,
LEGITIMATE_INTEREST_CLIENT,
PERFORMANCE_OF_CONTRACT,
CONSENT_WITH_NOTICE,
NON_GDPR,
PROCESS_AND_STORE,
LEGITIMATE_INTEREST_OTHER
​
legalBasisExplanation
string

Une explication plus détaillée pour accompagner la base juridique (obligatoire pour les portails respectant le RGPD).

Response

successful operation

​
name
string
required

Le nom de l'abonnement.

​
description
string
required

Une description de l'abonnement.

​
id
string
required

L'ID de l'abonnement.

​
status
enum<string>
required

Si le contact est abonné ou non.

Available options:
SUBSCRIBED,
NOT_SUBSCRIBED
​
sourceOfStatus
enum<string>
required

Lorsque le statut est déterminé, par exemple, à partir de PORTAL_WIDE_STATUS si le contact s'est désinscrit du portail.

Available options:
PORTAL_WIDE_STATUS,
BRAND_WIDE_STATUS,
SUBSCRIPTION_STATUS
​
brandId
integer

L'ID de la marque avec laquelle l'abonnement est associé, s'il y en a une.

​
legalBasis
enum<string>

La raison légale de l'état actuel de l'abonnement.

Available options:
LEGITIMATE_INTEREST_PQL,
LEGITIMATE_INTEREST_CLIENT,
PERFORMANCE_OF_CONTRACT,
CONSENT_WITH_NOTICE,
NON_GDPR,
PROCESS_AND_STORE,
LEGITIMATE_INTEREST_OTHER
​
preferenceGroupName
string

Le nom du groupe de préférences auquel l'abonnement est associé.

​
legalBasisExplanation
string

Une explication plus détaillée pour accompagner la base juridique.

⌘I