Saltar al contenido principal
POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
read
Recuperación por lotes de los estados de suscripción
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    "<string>"
  ]
}
'
{
  "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"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Starter
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito

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 tipo de canal para el tipo de suscripción. Actualmente el único tipo de canal admitido es EMAIL.

Opciones disponibles:
EMAIL
businessUnitId
integer<int64>

Si tienes el complemento unidad de negocio, incluye este parámetro para filtrar los resultados por el ID de la unidad de negocio. La unidad de negocio predeterminada de la cuenta siempre utilizará 0.

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 March 30, 2026