Zum Hauptinhalt springen
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": [
    {
      "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 Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis
Esta API requer um dos seguintes escopos:
communication_preferences.read
communication_preferences.read_write

Authorizations

Authorization
string
header
required

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

Path Parameters

emailAddress
string
required

The email address of the contact whose subscription statuses are being retrieved.

Response

successful operation

recipient
string
required

Endereço de e-mail do contato.

subscriptionStatuses
object[]
required

Uma lista de todos os status das assinaturas do contato.

I