Update agent
Patch editable agent fields. Omitted fields remain unchanged. The server applies name, script, voice, audio, language, call-screening purpose, and post-call field updates, then returns the updated agent. Edit the script’s Open step to change the opening words; beginMessage is read-only. Only the properties listed below are editable: an agent’s type is fixed at creation, and its capabilities are changed through the skills endpoints, so sending agentType or capabilityIds here is accepted but has no effect.
Use contextFields to replace the managed CRM context block without rewriting the rest of the script. For campaign outcome prompts use Update campaign → outcomes.
Required API key scope: agents:write.
Authorizations
Send your API key as Authorization: Bearer YOUR_API_KEY.
Path Parameters
Agent id.
1Body
Send the display name at the top level; settings may be flat top-level keys or nested under config. When both forms are present the flat key wins. Omitted fields are unchanged. Opening words are edited in the script's Open step; beginMessage is read-only.
New agent display name.
"Roofing Follow Up"
Optional editable agent configuration accepted on create and update. Omitted fields keep their template defaults on create, or remain unchanged on update.
The agent's script. Equivalent to config.llm.generalPrompt. The hidden platform layers are preserved server-side and must not be sent.
"# Context\nQualify the lead and book an appointment."
Replaces the full post-call analysis field list; read and preserve unrelated fields before writing. This flat form also carries the editable system presets call_summary, call_successful, and user_sentiment. The grouped config.analysis form exposes outcomes and custom fields; it does not expose preset prompt edits.
Voice identifier from the voices catalogue.
"11labs-Hugh"
0 <= x <= 20.7
0.5 <= x <= 21
How loud the agent's own voice is. 1 is normal, 0 is silent. For the background bed use backgroundSoundVolume.
0 <= x <= 21
Speech locale, or explicit locales for a multilingual agent. Empty selections and the retired multi value are rejected. Duplicates are removed. These locales must each be used alone: is-IS, fil-PH, hy-AM, ne-NP.
en-US, en-IN, en-GB, en-AU, en-NZ, de-DE, es-ES, es-419, hi-IN, fr-FR, fr-CA, ja-JP, pt-PT, pt-BR, zh-CN, ru-RU, it-IT, ko-KR, nl-NL, nl-BE, pl-PL, tr-TR, vi-VN, ro-RO, bg-BG, ca-ES, th-TH, da-DK, fi-FI, el-GR, hu-HU, id-ID, no-NO, sk-SK, sv-SE, lt-LT, lv-LV, cs-CZ, ms-MY, af-ZA, ar-SA, az-AZ, bs-BA, cy-GB, fa-IR, fil-PH, gl-ES, he-IL, hr-HR, hy-AM, is-IS, kk-KZ, kn-IN, mk-MK, mr-IN, ne-NP, sl-SI, sr-RS, sw-KE, ta-IN, ur-IN, uk-UA "en-US"
Background-noise handling mode.
no-denoise, noise-cancellation, noise-and-background-speech-cancellation "noise-cancellation"
Ambient bed played under the call. null removes it.
coffee-shop, convention-hall, summer-outdoor, mountain-outdoor, static-noise, call-center, null "coffee-shop"
Ambient bed volume on the PLATFORM scale: 0 to 2, where 1 is standard and 0 is selected-but-muted. NOTE that the dashboard slider and the builder assistant both speak a 0 to 100 operator scale where 50 is standard — 50 there is 1 here. This endpoint takes the 0 to 2 form only.
0 <= x <= 21
Whether the agent says "mm-hm" over the caller while they speak.
true
0 <= x <= 10.8
The backchannel utterances to choose from.
How soon the agent starts talking after the caller stops. This is a RATE: 1 replies as fast as it can, 0 waits longest. The dashboard presents the inverse as a delay percentage (0% immediate, 100% longest), so 0.96 here shows as 4% there.
0 <= x <= 10.96
Filler words the agent uses in its OWN speech, compiled into the agent prompt. Distinct from backchannelWords, which the voice stack speaks over the caller. Each key is optional; omitted keys keep their stored value.
The literal sentence the agent speaks when iOS/Android call screening answers and asks why it is calling. An utterance, not an instruction.
1 - 300"Calling about your roofing enquiry."
Complete managed CRM context field list. Omitted leaves the block unchanged; [] clears it. Do not combine with prompt or config.llm.generalPrompt. Field keys must exist in this project’s CRM.
