Skip to main content
PUT
Set an assistant's contact filter mode

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
mode
enum<string>
required
Available options:
off,
allowlist,
blocklist

Response

Successful Response

allowlist
ContactFilterEntryOut · object[]
required
blocklist
ContactFilterEntryOut · object[]
required
mode
enum<string>
required

off: every contact can trigger the assistant. allowlist: only contacts on the allowlist can. blocklist: every contact except those on the blocklist can.

Available options:
off,
allowlist,
blocklist