Pular para o conteúdo principal
GET
/
communication-preferences
/
v3
/
status
/
email
/
{emailAddress}
Obter status de assinatura para um contato
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>"
    }
  ]
}

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de caminho

emailAddress
string
obrigatório

Resposta

successful operation

recipient
string
obrigatório

Endereço de e-mail do contato.

subscriptionStatuses
object[]
obrigatório

Uma lista de todos os status das assinaturas do contato.

Last modified on April 13, 2026