Skip to main content
POST
Add contacts to an assistant's contact filter

Authorizations

Authorization
string
header
required

Personal access token (izap_pat_…) sent as Authorization: Bearer ; dashboard session JWTs are also accepted.

Headers

business-id
string | null
required

UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.

Path Parameters

chatbot_id
string<uuid>
required

Body

application/json
list
enum<string>
required

Which list to add the contacts to: allow or block.

Available options:
allow,
block
phone_numbers
string[]
required

A WhatsApp phone number with its country code (+5585987504325; spaces, dashes and parentheses are ignored), or a WhatsApp business-scoped user ID for contacts whose number is hidden. Numbers are stored in canonical E.164 form.

Required array length: 1 - 500 elements
label
string | null

Optional note stored with each contact.

Maximum string length: 100

Response

Successful Response

added
ContactFilterEntryOut · object[]
required
already_listed
string[]
required

Contacts that were already on the list, in canonical form.

invalid
string[]
required

Inputs that are not a usable phone number, as sent.