Skip to main content
POST
/
communication-preferences
/
v3
/
unsubscribe
Cancelar suscripción de un contacto
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>"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito
Esta API requiere uno de los siguientes ámbitos:
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

Dirección de correo del contacto.

​
subscriptionId
string
required

ID de la suscripción que se actualizará para el contacto.

​
legalBasis
enum<string>

Base jurídica para actualizar el estado del contacto (obligatorio para los portales habilitados para RGPD).

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

Una explicación más detallada que acompaña a la base jurídica (obligatorio para los portales habilitados para RGPD).

Response

successful operation

​
description
string
required

Una descripción de la suscripción.

​
id
string
required

El ID de la suscripción.

​
name
string
required

El nombre de la suscripción.

​
sourceOfStatus
enum<string>
required

Donde el estado se determina a partir de, por ejemplo, PORTAL_WIDE_STATUS si el contacto optó por salir del portal.

Available options:
BRAND_WIDE_STATUS,
PORTAL_WIDE_STATUS,
SUBSCRIPTION_STATUS
​
status
enum<string>
required

Si el contacto está suscrito.

Available options:
NOT_SUBSCRIBED,
SUBSCRIBED
​
brandId
integer<int64>

El ID de la marca con la que está asociada la suscripción, si hay una.

​
legalBasis
enum<string>

La razón legal del estado actual de la suscripción.

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

Una explicación más detallada que acompaña a la base jurídica.

​
preferenceGroupName
string

El nombre del grupo de preferencias con el que está asociada la suscripción.