Skip to main content
PATCH
Update agent

Authorizations

Authorization
string
header
required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Path Parameters

agent_id
string
required

The agent's id (agt_…).

Body

application/json
analysis
null | object

Replace the whole analysis block. Omit output_schema to remove structured extraction. Requires enabled=true to run.

archived
boolean
default:false

Archive to block new calls; false restores availability subject to draft validation. Accepted call snapshots remain unchanged.

background_sound
Available options:
off,
office
behavior
null | object

How the agent takes turns with the caller. Unlike other nested blocks, PATCH merges it field by field: omitted fields keep their current value and {} changes nothing. null resets it to the defaults (interruptions normal, adaptive_interruptions true).

calls_from
null | object

The phone number this agent's outbound calls ring from when the call, or its campaign, does not choose one. Resolution is fixed: the call's (or campaign's) phone_number_id, else this, else the Mirai shared line. A number set here dials through its own provider connection (India destinations only) and is re-checked before every call: if it can no longer call, calls fail with 409 not_ready and campaigns pause, never falling back to the shared line. null unsets it. Kept across a rollback.

draft
boolean
default:false

Drafts may have empty prompt or greeting, but cannot run calls.

emit_processed_webhook
boolean
default:true

Send call.processed when this agent has post-call tools, analysis or a flow (a flow agent's event carries the call's flow outcome). Set false to turn the event off.

emit_queued_webhook
boolean
default:false
end_call
object
first_message
string
Maximum string length: 500
flow
null | object

Optional node graph; makes this a flow agent. PATCH replaces the whole graph; null removes it.

if_revision
integer

PATCH only: reject a stale update with 409.

Required range: x >= 0
input_schema
object | null

Replace the entire input declaration. Null removes it and restores legacy string variables.

language
string
Minimum string length: 1
max_duration_secs
integer
default:300
Required range: 30 <= x <= 1800
name
string
Minimum string length: 1
secondary_languages
enum<string>[]

Other languages callers may speak. Speech recognition listens for them as well as the primary language. Optional; the primary language is never repeated here. Entries are reduced to their base code (gu-IN is saved as gu; or is accepted for od), duplicates and the primary language are dropped, and at most 4 remain. A PATCH replaces the whole list; [] or null clears it.

Maximum array length: 4
Available options:
hi,
en,
gu,
mr,
bn,
ta,
te,
kn,
ml,
pa,
od
system_prompt
string
Maximum string length: 12000
tools
null | object[]

At most 40 tools: 10 pre_call, 20 on_call, 10 post_call. A PATCH replaces the whole list; null empties it. To edit one tool, use PUT/DELETE /v2/agents/{id}/tools/{name}.

Maximum array length: 40
voice
object
voicemail
object

Response

The updated agent