Aller à la documentation
API

Annuler une diffusion

Arrête une diffusion `scheduled`, `queued` ou `sending`, y compris une qui a atteint tout le monde alors que certaines copies attendent encore de partir. Personne d'autre n'est ajouté, et chaque copie encore en attente est annulée.

POSTapi.openemail.uk/broadcasts/{id}/cancel

Exécute le véritable appel sur votre espace de travail, avec votre propre clé.

POST /broadcasts/{id}/cancel

Arrête une diffusion scheduled, queued ou sending, y compris une qui a atteint tout le monde alors que certaines copies attendent encore de partir. Personne d'autre n'est ajouté, et chaque copie encore en attente est annulée.

Exemple

Exige emails:send. Il n'y a pas de corps. La réponse est la diffusion complète, abrégée ici.

curl
curl -X POST "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/cancel" -H "$AUTH"
Réponse
{  "object": "broadcast",  "id": "brd_5a8c1e3f7b2d94a06c8e1f3b",  "status": "cancelled",  "counts": {    "recipients": 412,    "created": 250,    "skipped": 1,    "failedToQueue": 0,    "queued": 0,    "sending": 0,    "sent": 211,    "failed": 1,    "cancelled": 38  },  "cancelledAt": "2026-09-23T12:00:45.000Z"}

Une copie déjà en cours de remise va jusqu'au bout, et les copies parties ne peuvent pas être rappelées : counts.sent les conserve et counts.cancelled montre ce qui a été arrêté. Annuler avant scheduledAt n'envoie rien du tout.

Une fois toutes les copies parties, il ne reste rien à arrêter, et l'appel donne un 409 broadcast_not_cancellable. Une diffusion failed dont des copies attendent encore peut être annulée pour les arrêter, et une diffusion sans rien en attente est refusée de la même façon.

Annuler une diffusion déjà annulée la renvoie telle qu'elle est : réessayer est donc sans risque. Il n'y a pas de reprise.