Passer au contenu principal
POST
/
communication-preferences
/
2026-03
/
statuses
/
batch
/
unsubscribe-all
Désabonner par lots les contacts de tous les abonnements
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/unsubscribe-all \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    "<string>"
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "subscriberIdString": "<string>",
      "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>"
        }
      ]
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "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.

Paramètres de requête

channel
enum<string>
requis

Une chaîne de caractères requise spécifiant le canal de communication. Actuellement, seul l'« EMAIL » est pris en charge.

Options disponibles:
EMAIL
businessUnitId
integer<int64>

L'ID de l'unité commerciale à laquelle l'opération s'applique. Il s'agit d'un paramètre facultatif.

verbose
boolean
défaut:false

Un booléen indiquant s'il faut inclure des informations détaillées dans la réponse. La valeur par défaut est faux.

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 auxquelles l'opération de désinscription groupée a été effectuée.

results
object[]
requis

Un tableau contenant les résultats de l'opération de désabonnement groupée de toutes les communications.

startedAt
string<date-time>
requis

La date et l'heure auxquelles l'opération de désinscription groupée a commencé.

status
enum<string>
requis

Le statut actuel de l'opération de désinscription groupée, 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 lors de l'opération de désinscription groupée.

Une collection d'URL renvoyant vers des ressources ou de la documentation connexes.

numErrors
integer<int32>

Le nombre total d'erreurs rencontrées lors de l'opération de désinscription groupée.

requestedAt
string<date-time>

La date et l'heure auxquelles la demande de désinscription groupée a été effectuée.

Last modified on April 13, 2026