Saltar para a documentação
API

Esvaziar uma audiência

Retira todos os contactos da audiência numa única transação. A audiência fica, com o seu id, nome e descrição, e cada contacto continua no livro de endereços, na audiência predefinida e nas suas outras audiências.

POSTapi.openemail.uk/audiences/{id}/empty

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

POST /audiences/{id}/empty

Retira todos os contactos da audiência numa única transação. A audiência fica, com o seu id, nome e descrição, e cada contacto continua no livro de endereços, na audiência predefinida e nas suas outras audiências.

Exemplo

Requer audiences:write. Não há corpo.

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

A resposta é a audiência tal como ficou, mais removed, o número de pertenças retiradas. Esvaziar uma audiência que já está vazia responde removed: 0.

Não há como anular, e nada regista quem estava na lista. Percorra primeiro GET /audiences/{id}/contacts se a puder querer de volta. A aplicação pede à pessoa que confirme quem é antes de esvaziar uma lista, e uma chave não tem esse passo, por isso atribua audiences:write com cuidado.

A audiência predefinida incorporada não pode ser esvaziada. Essa chamada é recusada com 409 audience_immutable.