Saltar al contenido principal
POST
/
communication-preferences
/
2026-03
/
statuses
/
batch
/
read
Recuperación por lotes de los estados de suscripción
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>"
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "statuses": [
        {
          "source": "<string>",
          "subscriberIdString": "<string>",
          "subscriptionId": 123,
          "timestamp": "2023-11-07T05:31:56Z",
          "businessUnitId": 123,
          "legalBasisExplanation": "<string>",
          "subscriptionName": "<string>"
        }
      ],
      "subscriberIdString": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de consulta

channel
enum<string>
requerido

El canal de comunicación para filtrar los estados de suscripción. Debe ser "EMAIL".

Opciones disponibles:
EMAIL
businessUnitId
integer<int64>

Un número entero opcional que representa el ID de la unidad de negocio. Este parámetro ayuda a filtrar los resultados según la unidad de negocio específica.

Cuerpo

application/json
inputs
string[]
requerido

Una lista de cadenas que representan las entradas para las operaciones por lotes.

Respuesta

successful operation

completedAt
string<date-time>
requerido

La fecha y hora en que se completó el proceso por lotes.

results
object[]
requerido

La matriz de resultados del proceso por lotes, cada uno de los cuales contiene información sobre el estado de la suscripción.

startedAt
string<date-time>
requerido

La fecha y la hora en que comenzó el proceso por lotes.

status
enum<string>
requerido

El estado actual del proceso por lotes, que puede ser: PENDIENTE, PROCESANDO, CANCELADO o COMPLETADO.

Opciones disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

Una recopilación de enlaces relacionados asociados con la respuesta por lotes.

requestedAt
string<date-time>

La fecha y hora en que se realizó la solicitud por lotes.

Last modified on May 11, 2026