Get subscription preferences for a specific contact

Recupere as preferências atuais de assinatura de e-mail de um contato.

GET /communication-preferences/2026-03/statuses/{subscriberIdString}

Obter preferências de assinatura para um contato específico

cURL

curl --request GET \
  --url https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString} \
  --header 'Authorization: Bearer <token>'

200

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "channel": "EMAIL",
      "source": "<string>",
      "status": "NOT_SPECIFIED",
      "subscriberIdString": "<string>",
      "subscriptionId": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "businessUnitId": 123,
      "legalBasis": "CONSENT_WITH_NOTICE",
      "legalBasisExplanation": "<string>",
      "setStatusSuccessReason": "NO_STATUS_CHANGE",
      "subscriptionName": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

Required Scopes

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

subscriberIdString · string · obrigatório

O identificador exclusivo do assinante cujo status de preferências de comunicação está sendo recuperado.

Parâmetros de consulta

channel · enum<string> · obrigatório

Uma string obrigatória que indica o canal de comunicação para recuperar o status. O valor válido é 'EMAIL'.

Opções disponíveis: EMAIL

businessUnitId · integer<int64>

Um número inteiro opcional que representa o ID da unidade de negócio para filtrar o status da assinatura.

Resposta

200

application/json

successful operation

completedAt · string<date-time> · obrigatório

A data e a hora em que a operação foi concluída.

results · object[] · obrigatório

Uma série de resultados da operação.

Show child attributes

startedAt · string<date-time> · obrigatório

A data e a hora em que a operação começou.

status · enum<string> · obrigatório

Indica o status atual da operação, com valores possíveis: PENDING, PROCESSING, CANCELED, COMPLETE.

Opções disponíveis: CANCELED, COMPLETE, PENDING, PROCESSING

errors · object[]

Uma lista de erros que ocorreram durante a operação.

Show child attributes

links · object

Contém URLs relacionados à resposta, como documentação ou recursos.

Show child attributes

numErrors · integer<int32>

O número de erros que ocorreram durante a operação.

requestedAt · string<date-time>

A data e a hora em que a solicitação foi feita.