Skip to main content
POST
Listar quem fica de fora da campanha

Autorizações

Authorization
string
header
obrigatório

Token JWT de autenticação

Cabeçalhos

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Corpo

application/json
channel_type
enum<string>

Canal de disparo da campanha. Define a validação por canal.

Opções disponíveis:
WAP_AUTO_CLOSER,
WEB_V2,
EVOLUTION_API,
LINKEDIN,
MULTI_CHANNEL
audience_config
object

Audiência simulada, no mesmo formato da criação da campanha.

behavior_config
object

Regra de conversa aberta, como está configurada na tela.

exclusion_lists
object[]

Listas de exclusão, na ordem em que foram adicionadas. Quem está nelas fica de fora.

page
integer

Página. Padrão 1.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991
limit
integer

Itens por página. Padrão 20, no máximo 100.

Intervalo obrigatório: -9007199254740991 <= x <= 9007199254740991

Busca pelo nome do contato.

reason
enum<string>

Filtra pelo motivo de ficar de fora. Padrão all.

Opções disponíveis:
all,
filtered_out,
active_conversation,
exclusion_list,
no_active_channel

Resposta

201 - application/json

The response is of type object.