Skip to main content
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",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "subscriberIdString": "<string>",
      "statuses": [
        {
          "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.

Query Parameters

businessUnitId
integer

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.

verbose
boolean
default:false

Establecer en «true» para incluir los detalles de los estados de suscripción actualizados en la respuesta. Si no se incluye este parámetro, la respuesta será vacía.

channel
enum<string>
required

El tipo de canal para el tipo de suscripción. Actualmente el único tipo de canal admitido es EMAIL.

Available options:
EMAIL

Body

application/json
inputs
string[]
required

Una lista de cadenas que representan las entradas para las operaciones por lotes.

Response

successful operation

completedAt
string<date-time>
required

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

startedAt
string<date-time>
required

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

results
object[]
required

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

status
enum<string>
required

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

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

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.

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

errors
object[]

Una matriz de objetos de error que detalla cualquier problema encontrado durante la operación de exclusión por lotes.