Skip to main content
POST
Désabonner un contact de tous les abonnements

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) à désabonner de toutes les préférences de communication.

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>

Un entier facultatif représentant l'ID de l'unité commerciale. Il est utilisé pour spécifier le contexte de l'unité commerciale pour l'opération.

verbose
boolean
défaut:false

Un indicateur booléen spécifiant s'il faut inclure des informations détaillées dans la réponse. La valeur par défaut est false.

Réponse

successful operation

completedAt
string<date-time>
requis

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

results
object[]
requis

Une série de résultats issus 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

Indique l'état actuel de l'opération, avec les valeurs possibles suivantes : EN ATTENTE, EN COURS DE TRAITEMENT, ANNULÉ, TERMINÉ.

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

Liste des erreurs survenues pendant l'opération.

Contient les URL liées à la réponse, telles que la documentation ou les ressources.

numErrors
integer<int32>

Le nombre d'erreurs survenues pendant l'opération.

requestedAt
string<date-time>

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

Dernière modification le 1 avril 2026