Saltar para a documentação
API

Definir as audiências de um contacto

Diz exatamente em que audiências está um contacto, numa só chamada. O contacto entra em cada audiência de `audienceIds` onde ainda não está e sai de todas as outras. A audiência predefinida é sempre mantida, pelo que uma lista vazia deixa o contacto apenas na audiência predefinida.

PUTapi.openemail.uk/contacts/{email}/audiences

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

PUT /contacts/{email}/audiences

Diz exatamente em que audiências está um contacto, numa só chamada. O contacto entra em cada audiência de audienceIds onde ainda não está e sai de todas as outras. A audiência predefinida é sempre mantida, pelo que uma lista vazia deixa o contacto apenas na audiência predefinida.

Exemplo

Requer audiences:write, porque escreve pertenças e não o contacto. Codifique o @ no URL. audienceIds leva até 100 ids.

curl
curl -X PUT "$OE/contacts/grace%40example.com/audiences" -H "$AUTH" -H 'content-type: application/json' -d '{  "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71"]}'
Resposta
{  "object": "contact",  "email": "[email protected]",  "name": "Grace Hopper",  "source": "manual",  "notes": null,  "lastSeenAt": null,  "createdAt": "2026-09-18T09:00:00.000Z",  "updatedAt": "2026-09-18T09:00:00.000Z",  "audiences": [    { "id": "aud_9f2c4b7e1a0d63d84c5f2e7b", "name": "All contacts", "builtin": "default" },    { "id": "aud_4c1b8e2a7d9f05c36b4e8a71", "name": "Product updates", "builtin": null }  ]}

O contacto tem de existir já. Um endereço que não está no livro dá um 404 contact_not_found. Crie-o com POST /contacts, que também aceita audienceIds.

Um id que não designa nenhuma audiência deste espaço de trabalho dá um 404 audience_not_found e nada muda, pelo que um erro de escrita não pode tirar alguém de uma lista sem aviso. Repetir a mesma chamada não muda nada.

A resposta é o contacto tal como GET /contacts/{email} o devolve, com todas as audiências em que está depois da alteração.