Skip to main content
POST
List who is left out of the campaign

Authorizations

Authorization
string
header
required

JWT authentication token

Headers

x-company-id
string

Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.

Body

application/json
channel_type
enum<string>

The campaign's sending channel. Defines the per-channel validation.

Available options:
WAP_AUTO_CLOSER,
WEB_V2,
EVOLUTION_API,
LINKEDIN,
MULTI_CHANNEL
audience_config
object

Simulated audience, in the same format as campaign creation.

behavior_config
object

Open conversation rule, as configured on the screen.

exclusion_lists
object[]

Exclusion lists, in the order they were added. Anyone in them is left out.

page
integer

Page. Default 1.

Required range: -9007199254740991 <= x <= 9007199254740991
limit
integer

Items per page. Default 20, maximum 100.

Required range: -9007199254740991 <= x <= 9007199254740991

Search by contact name.

reason
enum<string>

Filters by the reason for being left out. Default all.

Available options:
all,
filtered_out,
active_conversation,
exclusion_list,
no_active_channel

Response

201 - application/json

The response is of type object.