Passer au contenu principal
POST
/
communication-preferences
/
v4
/
statuses
/
batch
/
write
Mettre à jour par lots le statut d'abonnement
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/batch/write \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "channel": "EMAIL",
      "subscriberIdString": "<string>",
      "subscriptionId": 123,
      "legalBasisExplanation": "<string>"
    }
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "channel": "EMAIL",
      "source": "<string>",
      "subscriberIdString": "<string>",
      "subscriptionId": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "businessUnitId": 123,
      "legalBasisExplanation": "<string>",
      "subscriptionName": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "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"
}

Supported products

Autorisations

Authorization
string
header
requis

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

Corps

application/json
inputs
object[]
requis

Un tableau d'objets PublicStatusRequest, chacun représentant les détails du statut d'abonnement pour un abonné spécifique. Cette propriété est requise.

Réponse

successful operation

completedAt
string<date-time>
requis

La date et l'heure de la fin de l'opération par lot.

results
object[]
requis

Un tableau contenant les résultats de l'opération par lot.

startedAt
string<date-time>
requis

La date et l'heure du début de l'opération par lot.

status
enum<string>
requis

Le statut actuel de l'opération par lot, qui peut être EN ATTENTE, EN COURS DE TRAITEMENT, ANNULÉE ou TERMINÉE.

Options disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

Un tableau d'objets d'erreur détaillant tous les problèmes rencontrés.

Des URL renvoyant vers des ressources ou de la documentation connexes.

numErrors
integer<int32>

Le nombre d'erreurs rencontrées pendant l'opération par lot.

requestedAt
string<date-time>

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

Dernière modification le 13 avril 2026