Batch retrieve subscription statuses

Recuperar status de assinatura em lote para um conjunto de contatos.

POST /communication-preferences/2026-03/statuses/batch/read

Recuperar status de assinatura em lote

cURL

curl --request POST \
  --url https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    "<string>"
  ]
}
'

200

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "statuses": [
        {
          "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>"
        }
      ],
      "subscriberIdString": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "links": {},
  "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 consulta

channel · enum<string> · obrigatório

O canal de comunicação para filtrar. Este parâmetro é obrigatório e atualmente só aceita 'EMAIL'.

Opções disponíveis: EMAIL

businessUnitId · integer<int64>

Um identificador opcional para a unidade de negócio. Este é um valor inteiro.

Corpo

application/json

inputs · string[] · obrigatório

Uma lista de strings que representam as entradas para operações em lote.

Resposta

200

application/json

successful operation

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

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

results · object[] · obrigatório

A série de resultados do processo em lote, cada um contendo informações de status da assinatura.

Show child attributes

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

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

status · enum<string> · obrigatório

O status atual do processo em lote, com valores possíveis: PENDING, PROCESSING, CANCELED, COMPLETE.

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

links · object

Uma coleção de links relacionados associados à resposta em lote.

Show child attributes

requestedAt · string<date-time>

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