API

Obtener un envío masivo

Un envío masivo con `counts` leídos en vivo de sus copias, lo que la convierte en la llamada que consultar mientras envía.

GETapi.openemail.uk/broadcasts/{id}

Ejecuta la llamada real contra tu espacio de trabajo, con tu propia clave.

GET /broadcasts/{id}

Un envío masivo con counts leídos en vivo de sus copias, lo que la convierte en la llamada que consultar mientras envía.

Ejemplo

Necesita emails:read.

curl

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

Respuesta

{  "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 id de otro espacio de trabajo es un 404 broadcast_not_found.

Para saber a quién fue cada copia y qué le pasó, lista las copias con GET /emails?broadcastId= y lee una con GET /emails/{id}.

Estados

Estado	Significa
scheduled	Esperando a `scheduledAt`.
queued	Esperando a que empiece el envío.
sending	Recorriendo las audiencias, o ya terminó de recorrerlas mientras aún hay copias esperando para salir. `completedAt` se fija en cuanto se alcanza a la última persona.
sent	Cada copia entregada ha salido o ha fallado.
cancelled	Detenido por `POST /broadcasts/{id}/cancel`.
failed	Todo el envío masivo se detuvo: ya no se puede enviar desde la dirección `from`, la plantilla dejó de resolverse, el plan se agotó a mitad, el propio envío falló una y otra vez, o no se pudo escribir ni una sola copia. `lastError` dice cuál.

Contadores

Contador	Significa
recipients	La estimación tomada al crear el envío masivo. No cambia después.
created	Copias escritas hasta ahora, una por persona alcanzada.
skipped	Personas omitidas porque su dirección estaba suprimida cuando el envío llegó a ellas.
failedToQueue	Personas cuya copia no se pudo escribir. `lastError` nombra la más reciente.
queued, sending, sent, failed, cancelled	Las copias según el estado en que está cada una ahora, contadas en vivo.