Skip to main content
PATCH
Change any agent fields. Send at least one field. Fields you leave out keep their values. Send "" or null for greeting to clear it. Field rules match Create agent. This includes transfer_targets (call transfer); send [] to turn transfers off. The change is applied to the agent’s copy in the call runtime when one exists. If that copy cannot be updated, the change is reverted and you get 502 AGENTS_UPSTREAM_UNAVAILABLE.

Request

Headers

string
required
Bearer token with your API key (scope agents)
string
required
application/json

Path

string
required
The agent id (UUID)

Body

Any field from Create agent, except webhook_secret. Most common:
string
1–64 characters, unique in the workspace
string
1–8,000 characters
string | null
Up to 500 characters. "" or null clears it
object
Replaces the defaults you send. Use the same keys as on create

Response

200 OK. The updated agent (same shape as Get agent, without phone_lines).

Errors

Example