Passer au contenu principal
GET
/
communication-preferences
/
2026-03
/
statuses
/
{subscriberIdString}
/
unsubscribe-all
Récupérer le statut de désabonnement d'un contact
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all \
  --header 'Authorization: Bearer <token>'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "channel": "EMAIL",
      "status": "NOT_SPECIFIED",
      "subscriberIdString": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "wideStatusType": "BUSINESS_UNIT_WIDE",
      "businessUnitId": 123
    }
  ],
  "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 chemin

subscriberIdString
string
requis

L'identifiant unique de l'abonné*e dont le statut de désabonnement est récupéré.

Paramètres de requête

channel
enum<string>
requis

Le canal de communication à partir duquel se désabonner. Doit être « EMAIL ».

Options disponibles:
EMAIL
businessUnitId
integer<int64>

L'ID de l'unité commerciale associée aux préférences de communication.

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.

Réponse

successful operation

completedAt
string<date-time>
requis

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

results
object[]
requis

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

startedAt
string<date-time>
requis

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

status
enum<string>
requis

Le statut actuel de l'opération, 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 pendant l'opération.

Un objet contenant des liens connexes, où chaque clé est un nom de lien et chaque valeur est une URL.

numErrors
integer<int32>

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

requestedAt
string<date-time>

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

Last modified on April 13, 2026