Saltar al contenido principal
POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
unsubscribe-all
/
read
Leer estados por lotes
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/batch/unsubscribe-all/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    "<string>"
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "subscriberIdString": "<string>",
      "wideStatuses": [
        {
          "channel": "EMAIL",
          "subscriberIdString": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "businessUnitId": 123
        }
      ]
    }
  ],
  "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 en el que verificar el estado de cancelación de suscripción. Este parámetro es obligatorio y actualmente solo admite "EMAIL".

Opciones disponibles:
EMAIL
businessUnitId
integer<int64>

El ID de la unidad de negocio. Este es un parámetro opcional.

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.

Última modificación el 13 de abril de 2026