Déprogrammer une campagne

DELETE /api/v1/campaigns/{campaignId}/schedule Annule un envoi réservé : une campagne scheduled — ou paused qui a encore une date — revient en draft, sans date. L'horaire réservé ne vaut plus, et la campagne ne partira pas tant que vous ne l'envoyez ou ne la programmez pas de nouveau.

Autorisation

Rôle dans l'organisation	Cet endpoint
`OWNER`	Autorisé
`ADMIN`	Autorisé
`MEMBER`	Refusé — `403`

Une clé porte le rôle que son créateur détient dans cette organisation — jamais un rôle sur AgentsMail lui-même. Voir Clés d'API.

Paramètres de chemin

Paramètre	Type	Description
`campaignId`	string	Identifiant unique d'une campagne

Exemple

bash

curl -X DELETE -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/campaigns/$CAMPAIGN_ID/schedule"

Réponse

200 OK — la campagne est revenue en draft.
401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
403 Forbidden — le propriétaire de la clé est member de l'organisation, pas admin.
404 Not Found — aucune campagne de ce type, ou elle appartient à une autre organisation.
409 Conflict — la campagne n'est pas programmée (brouillon, déjà en cours d'envoi, envoyée…), ou elle a changé entre votre lecture et cet appel. Rien n'est écrit.
429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

Champ	Type	Description
`success`	boolean	Indique si l'opération a réussi
`data.campaignId`	string	La campagne déprogrammée
`data.status`	string	Toujours `draft`

Exemple de réponse

json

{
  "success": true,
  "data": {"campaignId": "6c6c6c6c-5555-4aaa-8bbb-999900001111", "status": "draft"}
}

Notes

Trop tard, c'est trop tard : une fois la campagne sending, l'appel répond 409 et l'envoi continue.
Pour déplacer un départ plutôt que l'annuler, rappelez Programmer une campagne — inutile de déprogrammer d'abord.