Skip to main content
POST
Désabonner par lots les contacts 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 requête

channel
enum<string>
requis

Le canal de communication à partir duquel les abonnés seront désabonnés. Ce paramètre est obligatoire et ne prend actuellement en charge que l'« EMAIL ».

Options disponibles:
EMAIL
businessUnitId
integer<int64>

Un entier facultatif représentant l'ID de l'unité commerciale pour laquelle l'opération est effectuée.

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 false.

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.

Dernière modification le 1 avril 2026