Saltar para a documentação
API

Criar uma audiência

Cria uma audiência nova e vazia e devolve-a com o respetivo id. `name` é aparado e tem depois de ter entre 1 e 120 caracteres. `description` é texto livre opcional para quem vier a ler a lista mais tarde. Os nomes não são verificados quanto a duplicados, porque uma audiência é endereçada pelo id.

POSTapi.openemail.uk/audiences

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

POST /audiences

Cria uma audiência nova e vazia e devolve-a com o respetivo id. name é aparado e tem depois de ter entre 1 e 120 caracteres. description é texto livre opcional para quem vier a ler a lista mais tarde. Os nomes não são verificados quanto a duplicados, porque uma audiência é endereçada pelo id.

Exemplo

Requer audiences:write.

curl
curl -X POST "$OE/audiences" -H "$AUTH" -H 'content-type: application/json' -d '{  "name": "Product updates",  "description": "Customers who asked to hear about releases"}'
Resposta
{  "object": "audience",  "id": "aud_4c1b8e2a7d9f05c36b4e8a71",  "name": "Product updates",  "description": "Customers who asked to hear about releases",  "builtin": null,  "contactCount": 0,  "createdAt": "2026-09-18T09:10:00.000Z",  "updatedAt": "2026-09-18T09:10:00.000Z"}

builtin nunca é aceite no corpo do pedido. Exatamente uma linha por workspace o traz, e o servidor é o dono dessa linha.

Um workspace comporta no máximo 100 audiências. A seguinte é recusada com 422 audience_limit_reached em name.

Encha-a com a rota de adição, um contacto de cada vez, e os contactos têm de já estar no livro.