Saltar al contenido principal
POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
write
Actualizar por lotes el estado de la suscripción
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/batch/write \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "subscriberIdString": "<string>",
      "subscriptionId": 123,
      "legalBasisExplanation": "<string>"
    }
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "source": "<string>",
      "subscriberIdString": "<string>",
      "subscriptionId": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "businessUnitId": 123,
      "legalBasisExplanation": "<string>",
      "subscriptionName": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "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

Autorizaciones

Authorization
string
header
requerido

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

Cuerpo

application/json
inputs
object[]
requerido

Un conjunto de objetos PublicStatusRequest, cada uno de los cuales representa los detalles del estado de la suscripción de un suscriptor específico. Esta propiedad es obligatoria.

Respuesta

successful operation

completedAt
string<date-time>
requerido

La fecha y la hora en que se completó la operación por lotes.

results
object[]
requerido

Un conjunto que contiene los resultados de la operación por lotes.

startedAt
string<date-time>
requerido

La fecha y la hora en que se inició la operación por lotes.

status
enum<string>
requerido

El estado actual de la operación por lotes, puede ser PENDIENTE, PROCESANDO, CANCELADO o COMPLETADO.

Opciones disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

Una matriz de objetos de error que detalla cualquier problema encontrado.

URL con enlaces a recursos o documentación relacionados.

numErrors
integer<int32>

El número de errores encontrados durante la operación por lotes.

requestedAt
string<date-time>

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

Last modified on April 13, 2026