Skip to navigation

Update agent

Update an existing agent's configuration.

Only provided fields will be updated. Omitted fields remain unchanged.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

agent_idstringRequired

Request

This endpoint expects an object.
namestring or nullOptional>=1 character
Agent name
descriptionstring or nullOptional>=1 character
Agent description
custom_descriptionstring or nullOptional>=1 character
Custom agent description
languagestring or nullOptional>=1 character

Agent language: English, Hindi, Tamil, etc.

sectorstring or nullOptional>=1 character
Industry sector
tonestring or nullOptional>=1 character

Agent tone: professional, friendly, casual, formal

agent_rolestring or nullOptional>=1 character
Agent role
ai_modelstring or nullOptional>=1 character

AI model: lai-premium-2, lai-premium-3, lai-premium-4

voicestring or nullOptional>=1 character

Voice gender: male or female

voice_idstring or nullOptional>=1 character
Voice ID
accentstring or nullOptional>=1 character
Voice accent
pronunciationsmap from strings to strings or nullOptional
Custom pronunciations
voice_response_settingsobject or nullOptional

Voice & response settings

background_sounds_enabledboolean or nullOptional

Office background sound during calls; its volume is voice_response_settings.background_sound_volume

promptstring or nullOptional>=1 character

Agent prompt/instructions

start_flowstring or nullOptional>=1 character
Opening greeting
end_flowstring or nullOptional>=1 character
Closing message
details_to_collectlist of any or nullOptional
Details to collect
brand_namestring or nullOptional>=1 character
Brand name
typed_knowledgestring or nullOptional>=1 character
Knowledge base text
timezonestring or nullOptional>=1 character
Timezone
knowledge_base_idslist of strings or nullOptional

The FULL list of knowledge bases the agent searches; [] detaches all

webhook_configobject or nullOptional
Webhook config
custom_apilist of objects or nullOptional
Custom API configs
lookup_apiobject or nullOptional
Lookup API config
transfer_maplist of objects or nullOptional
Transfer map
other_languageslist of strings or nullOptional
Additional languages
conversation_flow_idstring or nullOptional

A call flow of yours (GET /v1/flows) for the agent to follow; "" turns the flow off

Response

Successful Response
dataobject
Full agent detail response.
request_idstring
timestampdatetime
successbooleanOptionalDefaults to true

Errors

422
Unprocessable Entity Error