Supressões

E-mails bloqueados para envio (bounces, descadastros) (`publiq.suppressions`).

O recurso suppressions mantém a lista de endereços que nunca devem receber e-mail: adicionar manualmente (ex.: pedido de LGPD/GDPR), listar as supressões da organização e remover um endereço em que você volta a confiar.

Referência de métodos

`suppressions.create`

suppressions.create(params) → Promise<Suppression>

Adiciona um endereço à lista de supressões da organização, bloqueando futuros envios para ele.

Parâmetros

Parâmetro	Tipo	Descrição
`email`Obrigatório	`string`	Endereço a suprimir.
`reason`Opcional	`string`	Um de `manual`, `bounce`, `complaint`, `unsubscribe` (padrão `manual`).

Retorna: A supressão criada — { object: "suppression", email, reason, ... }.

const suppression = await publiq.suppressions.create({
email: 'ana@example.com',
reason: 'manual',
});
console.log(suppression.email, suppression.reason);

Um endereço suprimido nunca recebe e-mail: o Publiq filtra por destinatário no momento do envio, então um cc/bcc suprimido é descartado silenciosamente e, se todos os to estiverem suprimidos, o envio é marcado como falho. Veja Entregabilidade.

Bounces e denúncias costumam ser adicionados automaticamente pelo Publiq — use create para supressões manuais (ex.: pedido de LGPD/GDPR) e delete para voltar a confiar em um endereço.

`suppressions.list`

suppressions.list({ limit?, after? }) → Promise<SuppressionList>

Lista as supressões da organização, com paginação por cursor.

Parâmetros

Parâmetro	Tipo	Descrição
`limit`Opcional	`number`	Itens por página (padrão 20, máx. 100).
`after`Opcional	`string`	Cursor: `id` do último item da página anterior.

Retorna: Envelope de lista { object: "list", data: Suppression[] }. Use o id do último item como after na próxima chamada.

const { data } = await publiq.suppressions.list({ limit: 50 });
// next page:
const next = await publiq.suppressions.list({ after: data[data.length - 1].id });

A listagem é paginada por cursor: itere passando o id do último item em after até data vir vazio. Veja Erros & paginação.

`suppressions.delete`

suppressions.delete(email) → Promise<void>

Remove um endereço da lista de supressões, permitindo que ele volte a receber e-mails.

Parâmetros

Parâmetro	Tipo	Descrição
`email`Obrigatório	`string`	Endereço suprimido a remover.

Retorna: Nenhum conteúdo (204).

await publiq.suppressions.delete('ana@example.com');

O SDK faz o url-encode do e-mail ao montar o caminho DELETE /suppressions/{email} — não é preciso escapar você mesmo.

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.