Skip to main content
POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
unsubscribe-all
/
read
Recuperar por lotes los contactos que han cancelado la suscripción a todas las comunicaciones
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",
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "wideStatuses": [
        {
          "wideStatusType": "PORTAL_WIDE",
          "subscriberIdString": "<string>",
          "channel": "EMAIL",
          "businessUnitId": 123,
          "status": "SUBSCRIBED",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "subscriberIdString": "<string>"
    }
  ],
  "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.read

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.

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 la hora en que se completó el proceso por lotes.

startedAt
string<date-time>
required

La fecha y la hora en que comenzó el proceso por lotes.

results
object[]
required

La matriz de resultados del proceso por lotes, cada uno de los cuales contiene información sobre el estado de la suscripción.

status
enum<string>
required

El estado actual del proceso por lotes, con los valores posibles: PENDIENTE, PROCESANDO, CANCELADO o COMPLETADO.

Available options:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
requestedAt
string<date-time>

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

Una colección de enlaces asociados con la respuesta por lotes.