Passer au contenu principal
POST
/
communication-preferences
/
2026-03
/
statuses
/
batch
/
read
Récupérer par lots les statuts d'abonnement
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    "<string>"
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "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>"
        }
      ],
      "subscriberIdString": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

Autorisations

Authorization
string
header
requis

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

Paramètres de requête

channel
enum<string>
requis

Le canal de communication à filtrer. Ce paramètre est obligatoire et ne prend actuellement en charge que l'« EMAIL ».

Options disponibles:
EMAIL
businessUnitId
integer<int64>

Un identifiant facultatif pour l'unité commerciale. Il s'agit d'une valeur entière.

Corps

application/json
inputs
string[]
requis

Liste de chaînes représentant les entrées pour les opérations par lots.

Réponse

successful operation

completedAt
string<date-time>
requis

La date et l'heure de la fin du processus par lot.

results
object[]
requis

Le tableau des résultats du traitement par lots, chacun contenant des informations sur l'état de l'abonnement.

startedAt
string<date-time>
requis

La date et l'heure du début du processus par lot.

status
enum<string>
requis

Statut actuel du processus par lots, avec les valeurs possibles suivantes : EN ATTENTE, EN COURS DE TRAITEMENT, ANNULÉ, TERMINÉ.

Options disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

Une collection de liens associés à la réponse par lot.

requestedAt
string<date-time>

La date et l'heure auxquelles la demande par lot a été faite.

Last modified on April 13, 2026