Documentation de Maildrop

Subscriber.UnsubscribeBatch

URL https://api.dpmail.fr/json/Subscriber.UnsubscribeBatch.php

Désinscrire plusieurs abonnés d'une liste de contact.

Paramètres et infos requises

ListID - String
L'identifiant de la liste dont les contacts seront désinscrits.

Emails - JsonString
Une chaine JSON encodant un tableau d'adresses email à désinscrire.

Codes de retour

Succès

0: Success
L'opération s'est correctement déroulée. Voir les données de réponse pour connaitre la liste des contacts qui ont été désinscrits.

Erreur

11: Format JSON illisible
Le format JSON du paramètre Emails est illisible/indécodable.

301: ListID Invalide
ListID doit être une chaine de 32 caractères correspondant à la liste de contact dont les emails seront désabonnées.

Format de données en entrée pour le paramètre "Emails"

[
  "azer@uipo.tld",
  "qwerty@uipo.tld",
  "..."
]

Format des données en sortie

{
  "unsubscribed_count" : 2,
  "unsubscribed" : [
    "azer@uipo.tld",
    "..."
  ]
}
  • unsubscribed_count indique le nombre de désinscriptions effectives.
  • unsubscribed contient la liste des adresses emails effectivement désabonnées.