POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
read
Recuperación por lotes de los estados de suscripción
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/batch/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": [
    {
      "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"
        }
      ]
    }
  ],
  "status": "PENDING"
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubGratuito
Sales HubSales HubGratuito
Service HubService HubGratuito
Content HubContent HubGratuito

Ámbitos Requeridos

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

Response

successful operation

The response is of type object.