Skip to main content
POST
/
communication-preferences
/
v3
/
subscribe
Suscribir a un contacto
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v3/subscribe \
  --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"
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubGratuito
Sales HubSales HubGratuito
Service HubService HubGratuito
Content HubContent HubGratuito

​
Ámbitos Requeridos

Esta API requiere uno de los siguientes ámbitos:
  • communication_preferences.write
  • communication_preferences.read_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:
LEGITIMATE_INTEREST_PQL,
LEGITIMATE_INTEREST_CLIENT,
PERFORMANCE_OF_CONTRACT,
CONSENT_WITH_NOTICE,
NON_GDPR,
PROCESS_AND_STORE,
LEGITIMATE_INTEREST_OTHER
​
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

​
name
string
required

El nombre de la suscripción.

​
description
string
required

Una descripción de la suscripción.

​
id
string
required

El ID de la suscripción.

​
status
enum<string>
required

Si el contacto está suscrito.

Available options:
SUBSCRIBED,
NOT_SUBSCRIBED
​
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:
PORTAL_WIDE_STATUS,
BRAND_WIDE_STATUS,
SUBSCRIPTION_STATUS
​
brandId
integer

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:
LEGITIMATE_INTEREST_PQL,
LEGITIMATE_INTEREST_CLIENT,
PERFORMANCE_OF_CONTRACT,
CONSENT_WITH_NOTICE,
NON_GDPR,
PROCESS_AND_STORE,
LEGITIMATE_INTEREST_OTHER
​
preferenceGroupName
string

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

​
legalBasisExplanation
string

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

⌘I