Zum Hauptinhalt springen
POST
/
communication-preferences
/
v3
/
subscribe
Inscrever um contato
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"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • 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

Endereço de e-mail do contato.

​
subscriptionId
string
required

O ID da assinatura que está sendo atualizada para o contato.

​
legalBasis
enum<string>

Base jurídica para atualizar o status do contato (necessário para portais com o Regulamento Geral sobre a Proteção de Dados habilitado).

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

Uma explicação mais detalhada para acompanhar a base jurídica (obrigatória para portais com o Regulamento Geral sobre a Proteção de Dados habilitado).

Response

successful operation

​
name
string
required

O nome da assinatura.

​
description
string
required

Uma descrição da assinatura.

​
id
string
required

O ID da assinatura.

​
status
enum<string>
required

Se o contato está inscrito.

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

De onde o status é determinado, por exemplo, PORTAL_WIDE_STATUS se o contato optou por não aderir ao portal.

Available options:
PORTAL_WIDE_STATUS,
BRAND_WIDE_STATUS,
SUBSCRIPTION_STATUS
​
brandId
integer

O ID da marca com a qual a assinatura está associada, se houver.

​
legalBasis
enum<string>

O motivo legal para o status atual da assinatura.

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

O nome do grupo de preferências ao qual a assinatura está associada.

​
legalBasisExplanation
string

Uma explicação mais detalhada para acompanhar a base jurídica.

⌘I