API

Récupérer une diffusion

Une diffusion avec des `counts` lus en direct depuis ses copies, ce qui en fait l'appel à interroger pendant l'envoi.

GETapi.openemail.uk/broadcasts/{id}

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

GET /broadcasts/{id}

Une diffusion avec des counts lus en direct depuis ses copies, ce qui en fait l'appel à interroger pendant l'envoi.

Exemple

Exige emails:read.

curl

curl "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b" -H "$AUTH"

Réponse

{  "object": "broadcast",  "id": "brd_5a8c1e3f7b2d94a06c8e1f3b",  "status": "sending",  "mode": "live",  "source": "api",  "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71"],  "from": "Acme <[email protected]>",  "subject": "{{firstName|Hello}}, the September release is out",  "counts": {    "recipients": 412,    "created": 250,    "skipped": 1,    "failedToQueue": 0,    "queued": 38,    "sending": 2,    "sent": 209,    "failed": 1,    "cancelled": 0  },  "lastError": null,  "scheduledAt": null,  "startedAt": "2026-09-23T12:00:02.000Z",  "completedAt": null,  "cancelledAt": null,  "createdAt": "2026-09-23T12:00:00.000Z",  "updatedAt": "2026-09-23T12:00:41.000Z"}

Un identifiant d'un autre espace de travail donne un 404 broadcast_not_found.

Pour savoir à qui chaque copie est partie et ce qu'il en est advenu, listez les copies avec GET /emails?broadcastId= et lisez-en une avec GET /emails/{id}.

Statuts

Statut	Signification
scheduled	En attente de `scheduledAt`.
queued	En attente du démarrage de l'envoi.
sending	Parcourt les audiences, ou a fini de les parcourir alors que des copies attendent encore de partir. `completedAt` est fixé dès que la dernière personne a été atteinte.
sent	Chaque copie confiée est partie ou a échoué.
cancelled	Arrêtée par `POST /broadcasts/{id}/cancel`.
failed	La diffusion entière s'est arrêtée : l'adresse `from` ne peut plus servir à envoyer, le modèle ne se résout plus, la formule s'est épuisée en route, l'envoi lui-même a échoué à répétition, ou pas une seule copie n'a pu être écrite. `lastError` dit laquelle.

Compteurs

Compteur	Signification
recipients	L'estimation prise à la création de la diffusion. Elle ne bouge plus ensuite.
created	Copies écrites jusqu'ici, une par personne atteinte.
skipped	Personnes laissées de côté parce que leur adresse était supprimée au moment où l'envoi les a atteintes.
failedToQueue	Personnes dont la copie n'a pas pu être écrite. `lastError` désigne la plus récente.
queued, sending, sent, failed, cancelled	Les copies selon l'état où chacune se trouve maintenant, comptées en direct.