API

Einen Broadcast abrufen

Ein Broadcast mit `counts`, live aus seinen Kopien gelesen, was dies zum Aufruf macht, den Sie während des Versands abfragen.

GETapi.openemail.uk/broadcasts/{id}

Führt den echten Aufruf gegen Ihren Workspace aus, mit Ihrem eigenen Schlüssel.

GET /broadcasts/{id}

Ein Broadcast mit counts, live aus seinen Kopien gelesen, was dies zum Aufruf macht, den Sie während des Versands abfragen.

Beispiel

Benötigt emails:read.

curl

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

Antwort

{  "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"}

Eine ID aus einem anderen Workspace ist ein 404 broadcast_not_found.

Um zu sehen, an wen jede Kopie ging und was mit ihr geschah, listen Sie die Kopien mit GET /emails?broadcastId= auf und lesen Sie eine mit GET /emails/{id}.

Status

Status	Bedeutet
scheduled	Wartet auf `scheduledAt`.
queued	Wartet darauf, dass der Versand beginnt.
sending	Geht die Audiences durch oder ist damit fertig, während noch Kopien auf den Versand warten. `completedAt` wird gesetzt, sobald die letzte Person erreicht wurde.
sent	Jede übergebene Kopie ist hinausgegangen oder fehlgeschlagen.
cancelled	Gestoppt durch `POST /broadcasts/{id}/cancel`.
failed	Der ganze Broadcast ist gestoppt: Von der `from`-Adresse kann nicht mehr gesendet werden, die Vorlage lässt sich nicht mehr auflösen, der Plan ist unterwegs ausgeschöpft, der Versand selbst ist wiederholt fehlgeschlagen, oder keine einzige Kopie ließ sich schreiben. `lastError` sagt, was davon.

Zähler

Zähler	Bedeutet
recipients	Die beim Erstellen des Broadcasts ermittelte Schätzung. Sie ändert sich danach nicht mehr.
created	Bisher geschriebene Kopien, eine pro erreichter Person.
skipped	Personen, die übergangen wurden, weil ihre Adresse gesperrt war, als der Versand sie erreichte.
failedToQueue	Personen, deren Kopie nicht geschrieben werden konnte. `lastError` nennt die jüngste.
queued, sending, sent, failed, cancelled	Die Kopien nach dem Zustand, in dem jede gerade ist, live gezählt.