Saltar para a documentação
API

Obter uma cópia de uma difusão

A cópia de uma pessoa: a mesma linha que `GET /broadcasts/{id}/recipients` lista, mais o assunto, o HTML e o texto exatamente como essa pessoa os recebeu, com os campos de fusão preenchidos e a sua própria ligação para cancelar a subscrição.

GETapi.openemail.uk/broadcasts/{id}/recipients/{emailId}

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

GET /broadcasts/{id}/recipients/{emailId}

A cópia de uma pessoa: a mesma linha que GET /broadcasts/{id}/recipients lista, mais o assunto, o HTML e o texto exatamente como essa pessoa os recebeu, com os campos de fusão preenchidos e a sua própria ligação para cancelar a subscrição.

Exemplo

Precisa de emails:read. emailId é o emailId da cópia, vindo da lista de destinatários. A resposta aparece aqui encurtada.

curl
curl "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/recipients/msg_01dad25067bc4dac966d515d" -H "$AUTH"
Resposta
{  "object": "broadcast_recipient",  "emailId": "msg_01dad25067bc4dac966d515d",  "email": "[email protected]",  "name": "Ada Lovelace",  "status": "sent",  "deliveredAt": "2026-09-23T12:00:11.000Z",  "opens": 3,  "clicks": 1,  "unsubscribedAt": null,  "subject": "Ada, the September release is out",  "html": "<p>Hi Ada,</p><p>Here is what changed this month.</p>",  "text": "Hi Ada, here is what changed this month. Unsubscribe: https://…"}

O HTML é de antes de ser acrescentado o seguimento de aberturas e cliques, por isso é o que escreveu com os campos de fusão preenchidos, não os bytes que levaram o pixel de seguimento e as ligações reescritas.

Um emailId que não é uma cópia desta difusão é um 404 recipient_not_found, mesmo quando corresponde a outro e-mail do espaço de trabalho.

Recusas

EstadoCódigoQuando
400invalid_cursorNa lista de destinatários, um cursor que essa lista não entregou.
403insufficient_scopeA chave não tem emails:read.
404broadcast_not_foundO id não indica nenhuma difusão deste workspace, ou a chave está limitada a determinados endereços ou domínios e a difusão saiu de um que ela não tem.
404recipient_not_foundEm GET /broadcasts/{id}/recipients/{emailId}, um emailId que não é uma cópia desta difusão.