Marketing
Português (BR)
cURL
curl --request GET \ --url https://api.hubapi.com/communication-preferences/v3/status/email/{emailAddress} \ --header 'Authorization: Bearer <token>'
{ "recipient": "<string>", "subscriptionStatuses": [ { "description": "<string>", "id": "<string>", "name": "<string>", "sourceOfStatus": "BRAND_WIDE_STATUS", "status": "NOT_SUBSCRIBED", "brandId": 123, "legalBasis": "CONSENT_WITH_NOTICE", "legalBasisExplanation": "<string>", "preferenceGroupName": "<string>" } ] }
Retorna uma lista de assinaturas e seus status para um determinado contato.
Produtos suportados
Escopos Necessários
The access token received from the authorization server in the OAuth 2.0 flow.
successful operation
Endereço de e-mail do contato.
Uma lista de todos os status das assinaturas do contato.
Mostrar atributos filhos
Uma descrição da assinatura.
O ID da assinatura.
O nome da assinatura.
De onde o status é determinado, por exemplo, PORTAL_WIDE_STATUS se o contato optou por não aderir ao portal.
BRAND_WIDE_STATUS
PORTAL_WIDE_STATUS
SUBSCRIPTION_STATUS
Se o contato está inscrito.
NOT_SUBSCRIBED
SUBSCRIBED
O ID da marca com a qual a assinatura está associada, se houver.
O motivo legal para o status atual da assinatura.
CONSENT_WITH_NOTICE
LEGITIMATE_INTEREST_CLIENT
LEGITIMATE_INTEREST_OTHER
LEGITIMATE_INTEREST_PQL
NON_GDPR
PERFORMANCE_OF_CONTRACT
PROCESS_AND_STORE
Uma explicação mais detalhada para acompanhar a base jurídica.
O nome do grupo de preferências ao qual a assinatura está associada.