Skip to main content
PATCH
Patch update agent
This is the primary way to configure an agent after creation — rename it, set its prompt/greeting, assign a telephony number, or connect WhatsApp. Only the fields you include are changed; everything else is left as-is.

Path parameters

string
required
The agent ID

Common body fields

string
New display name
string
First line the agent speaks/sends
string
System prompt
object
Free-form metadata, e.g. { fallback_message }
string
"VOICE" when setting telephony fields below
object
Channel-specific settings — see examples
string
An integration ID (e.g. the WhatsApp integration)
To enable WhatsApp on an agent, first call POST /agents/{id}/webhook-token to generate its per-agent webhook token, then patch the connection as above.