Skip to main content
PATCH
Update Meta agent settings

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

connection_id
string
required

The ID of the connection

phone_number_id
string
required

The ID of the WhatsApp phone number the Meta agent runs on

Query Parameters

agent_id
string

The agent settings to read or change. Defaults to the most recent ones.

Maximum string length: 128

Body

rollout
object
handoff
object
followup
object
ai_audience
enum<string>

Who the agent answers. ALLOWLISTED_ONLY is test mode: only the allowlisted numbers get replies.

Available options:
EVERYONE,
ALLOWLISTED_ONLY
never_say_phrases
string[]

Replaces the whole list: an answer containing one of these phrases is withheld. An empty list clears it.

Maximum array length: 200
Maximum string length: 256

Response

200 - application/json
agent_id
string
required
channel
string
required
rollout
object
required
handoff
object
required
followup
object
required
ai_audience
enum<string>
required

Who the agent answers. ALLOWLISTED_ONLY is test mode: only the allowlisted numbers get replies.

Available options:
EVERYONE,
ALLOWLISTED_ONLY
never_say_phrases
string[]