Audiências

Listas de contatos para marketing e segmentação (`publiq.audiences`).

O recurso audiences representa listas de contatos usadas para marketing e segmentação: crie uma audiência para agrupar contatos e liste as audiências da organização.

Referência de métodos

`audiences.create`

audiences.create(params) → Promise<Audience>

Cria uma nova audiência (lista de contatos). A audiência nasce vazia — adicione contatos a ela depois de criada.

Parâmetros

Parâmetro	Tipo	Descrição
`name`Obrigatório	`string`	Nome da audiência (1 a 200 caracteres).

Retorna: A audiência criada — { object: "audience", id, name, ... }.

const audience = await publiq.audiences.create({
name: 'Newsletter subscribers',
});
console.log(audience.id, audience.name); // "aud_...", "Newsletter subscribers"

Audiências guardam contatos e são o alvo de broadcasts. Veja Contatos para adicionar contatos e Broadcasts para enviar campanhas. Para subconjuntos com regras dentro de uma audiência, veja Segmentos.

`audiences.list`

audiences.list() → Promise<AudienceList>

Lista todas as audiências da organização. Sem parâmetros — não há paginação por cursor aqui, apenas o escopo da organização.

Retorna: Envelope de lista { object: "list", data: Audience[] } com as audiências da organização.

const { data } = await publiq.audiences.list();
for (const audience of data) {
console.log(audience.id, audience.name);
}

Os exemplos mostram Node, Python e PHP. No Python os métodos são snake_case (ex.: cancel_run, from_spec) e recebem um dict; no PHP são camelCase e recebem um array associativo. As chaves do corpo são sempre camelCase (templateKey, firstName, scheduledAt) — o retorno da API vem em snake_case.