Supprimer une série

DELETE /api/v1/series/{seriesId} Supprime la série, ses versions, ses étapes et ses liaisons. Définitif. Les campagnes déjà envoyées par ses étapes ne sont pas supprimées : elles sont parties, elles ont des statistiques, et elles font partie de votre historique.

Autorisation

RôleAccès
OWNERAutorisé
ADMINAutorisé
MEMBERRefusé — 403

Paramètres de chemin

ParamètreTypeDescription
seriesIdstring (uuid)L'identifiant de la série

Exemple

bash
curl -s -X DELETE 'https://www.agentsmail.io/api/v1/series/7d7d7d7d-8888-4ccc-9ddd-eeee00001111' \
  -H "x-api-key: $AGENTMAIL_API_KEY"

Réponse

CodeQuand
200Supprimée
400Cet identifiant est celui d'une séquence, pas d'une série
401Clé absente ou invalide
403Le rôle de la clé est MEMBER
404Aucune série avec cet identifiant dans votre organisation

Champs de la réponse

ChampTypeDescription
successbooleanToujours true ici
data.idstringL'identifiant supprimé

Exemple de réponse

json
{"success": true, "data": {"id": "7d7d7d7d-8888-4ccc-9ddd-eeee00001111"}}

Remarques

Mettez d'abord la série en pause si elle tourne. Une série supprimée cesse immédiatement de produire des campagnes.

Voir aussi