API

Obter uma difusão

Uma difusão com `counts` lidos ao vivo a partir das suas cópias, o que faz desta a chamada a consultar enquanto envia.

GETapi.openemail.uk/broadcasts/{id}

Executa a chamada real contra o seu espaço de trabalho, com a sua própria chave.

GET /broadcasts/{id}

Uma difusão com counts lidos ao vivo a partir das suas cópias, o que faz desta a chamada a consultar enquanto envia.

Exemplo

Precisa de emails:read.

curl

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

Resposta

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

Um id de outro workspace dá 404 broadcast_not_found.

Para saber para quem foi cada cópia e o que lhe aconteceu, liste as cópias com GET /emails?broadcastId= e leia uma com GET /emails/{id}.

Estados

Estado	Significa
scheduled	À espera de `scheduledAt`.
queued	À espera de que o envio comece.
sending	A percorrer as audiências, ou já terminou de as percorrer enquanto ainda há cópias à espera de sair. `completedAt` fica definido assim que a última pessoa é alcançada.
sent	Cada cópia entregue saiu ou falhou.
cancelled	Parada por `POST /broadcasts/{id}/cancel`.
failed	A difusão inteira parou: o endereço `from` já não pode enviar, o modelo deixou de se resolver, o plano esgotou-se a meio, o próprio envio falhou repetidamente, ou nem uma cópia pôde ser escrita. `lastError` diz qual.

Contadores

Contador	Significa
recipients	A estimativa tirada quando a difusão foi criada. Não muda depois.
created	Cópias escritas até agora, uma por pessoa alcançada.
skipped	Pessoas passadas à frente porque o endereço estava suprimido quando o envio lá chegou.
failedToQueue	Pessoas cuja cópia não pôde ser escrita. `lastError` indica a mais recente.
queued, sending, sent, failed, cancelled	As cópias pelo estado em que cada uma está agora, contadas ao vivo.