Skip to main content
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": [
    {
      "statusState": "SUBSCRIBED",
      "channel": "EMAIL",
      "subscriberIdString": "<string>",
      "legalBasis": "LEGITIMATE_INTEREST_PQL",
      "subscriptionId": 123,
      "legalBasisExplanation": "<string>"
    }
  ]
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "subscriptionName": "<string>",
      "channel": "EMAIL",
      "subscriberIdString": "<string>",
      "legalBasis": "LEGITIMATE_INTEREST_PQL",
      "setStatusSuccessReason": "RESUBSCRIBE_OCCURRED",
      "source": "<string>",
      "subscriptionId": 123,
      "legalBasisExplanation": "<string>",
      "businessUnitId": 123,
      "status": "SUBSCRIBED",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "errors": [
    {
      "subCategory": "",
      "context": "",
      "links": "",
      "id": "",
      "category": "",
      "message": "",
      "errors": "",
      "status": ""
    }
  ],
  "status": "PENDING"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito
Esta API requiere uno de los siguientes ámbitos:
communication_preferences.statuses.batch.write

Authorizations

Authorization
string
header
required

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

Body

application/json
inputs
object[]
required

Response

successful operation

completedAt
string<date-time>
required

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

startedAt
string<date-time>
required

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

results
object[]
required

Una matriz que contiene los resultados de la operación por lotes.

status
enum<string>
required

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

Available options:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
numErrors
integer

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.

URL con enlaces a recursos o documentación relacionados.

errors
object[]

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