Sign in
Business Agent

Update agent settings

Partial update: fields you omit keep their value. rollout.enabled: true turns the agent on for new conversations; false stops it on every thread. Turning it on for EVERYONE needs a payment method on the Business Agent billable account (Meta accepts the call but delivers nothing without one); ALLOWLISTED_ONLY does not, which is how you test with a few numbers before billing. never_say_phrases replaces the whole list.

patch/v1/accounts/{accountId}/business-agent/settings

Path parameters

accountIdstring required

WhatsApp social account id (the number must be managed through the Cloud API).

Query parameters

agentIdstring

Request body

ai_audience'EVERYONE' | 'ALLOWLISTED_ONLY'
never_say_phrasesstring[]

Exact phrases the agent must never say; the full replacement list.

Response

Updated settings

agent_idstring required
channelstring required
ai_audience'EVERYONE' | 'ALLOWLISTED_ONLY' | 'null' nullable

EVERYONE answers all consumers; ALLOWLISTED_ONLY answers only the allowlist and needs no payment method.

never_say_phrasesstring[]

Exact phrases the agent must never say.

Example response

{
  "channel": "whatsapp"
}

Changes