Ir a la documentación
API

Cancelar un envío masivo

Detiene un envío masivo que está `scheduled`, `queued` o `sending`, incluido uno que ya llegó a todos mientras algunas copias aún esperan para salir. No se añade a nadie más y se cancela cada copia que aún espera.

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

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

POST /broadcasts/{id}/cancel

Detiene un envío masivo que está scheduled, queued o sending, incluido uno que ya llegó a todos mientras algunas copias aún esperan para salir. No se añade a nadie más y se cancela cada copia que aún espera.

Ejemplo

Necesita emails:send. No lleva cuerpo. La respuesta es el envío masivo completo, abreviado aquí.

curl
curl -X POST "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/cancel" -H "$AUTH"
Respuesta
{  "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"}

Una copia que ya se está entregando termina, y las copias que salieron no se pueden recuperar, así que counts.sent las conserva y counts.cancelled muestra lo que se detuvo. Cancelar antes de scheduledAt no envía nada en absoluto.

Cuando todas las copias han salido ya no queda nada que detener, y la llamada es un 409 broadcast_not_cancellable. Un envío masivo failed con copias todavía en espera se puede cancelar para detenerlas, y uno sin nada en espera se rechaza igual.

Cancelar un envío masivo ya cancelado lo devuelve tal como está, así que reintentar es seguro. No hay forma de reanudarlo.