Saltar al contenido principal
POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
unsubscribe-all
Cancelar por lotes la suscripción de contactos de todas las suscripciones
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/batch/unsubscribe-all \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    "<string>"
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "subscriberIdString": "<string>",
      "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>"
        }
      ]
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://developers.hubspot.es/docs/llms.txt

Use this file to discover all available pages before exploring further.

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 darse de baja. Este parámetro es obligatorio y debe ser 'EMAIL'.

Opciones disponibles:
EMAIL
businessUnitId
integer<int64>

El ID de la unidad de negocio a la que se aplica la operación. Es un parámetro opcional.

verbose
boolean
predeterminado:false

Un valor booleano que indica si se debe incluir información detallada del procesamiento en la respuesta. De forma predeterminada, es falso.

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ó la operación de exclusión por lotes.

results
object[]
requerido

Una matriz que contiene los resultados de la operación de exclusión por lotes de todas las comunicaciones.

startedAt
string<date-time>
requerido

La fecha y hora en que comenzó la operación de exclusión por lotes.

status
enum<string>
requerido

El estado actual de la operación de exclusión por lotes, que 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 durante la operación de exclusión por lotes.

Una recopilación de URL con enlaces a recursos o documentación relacionados.

numErrors
integer<int32>

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

requestedAt
string<date-time>

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

Last modified on April 13, 2026