Pular para o conteúdo principal
POST
/
communication-preferences
/
v3
/
unsubscribe
Cancelar inscrição de um contato
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>"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Enterprise
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis

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).

Opções disponíveis:
CONSENT_WITH_NOTICE,
LEGITIMATE_INTEREST_CLIENT,
LEGITIMATE_INTEREST_OTHER,
LEGITIMATE_INTEREST_PQL,
NON_GDPR,
PERFORMANCE_OF_CONTRACT,
PROCESS_AND_STORE
​
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

​
description
string
required

Uma descrição da assinatura.

​
id
string
required

O ID da assinatura.

​
name
string
required

O nome da assinatura.

​
sourceOfStatus
enum<string>
required

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

Opções disponíveis:
BRAND_WIDE_STATUS,
PORTAL_WIDE_STATUS,
SUBSCRIPTION_STATUS
​
status
enum<string>
required

Se o contato está inscrito.

Opções disponíveis:
NOT_SUBSCRIBED,
SUBSCRIBED
​
brandId
integer<int64>

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.

Opções disponíveis:
CONSENT_WITH_NOTICE,
LEGITIMATE_INTEREST_CLIENT,
LEGITIMATE_INTEREST_OTHER,
LEGITIMATE_INTEREST_PQL,
NON_GDPR,
PERFORMANCE_OF_CONTRACT,
PROCESS_AND_STORE
​
legalBasisExplanation
string

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

​
preferenceGroupName
string

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