Update agent

Patches an Agent settings

Path parameters

agent_idstringRequired
The id of an agent. This is returned on agent creation.

Headers

xi-api-keystringRequired

Request

This endpoint expects an object.
conversation_configobjectOptional
Conversation configuration for an agent
platform_settingsobjectOptional
Platform settings for the agent are all settings that aren't related to the conversation orchestration and content.
namestringOptional
A name to make the agent easier to find
tagslist of stringsOptional
Tags to help classify and filter the agent

Response

Successful Response
agent_idstring
The ID of the agent
namestring
The name of the agent
conversation_configobject
The conversation configuration of the agent
metadataobject
The metadata of the agent
platform_settingsobject or null
The platform settings of the agent
phone_numberslist of objects or null
The phone numbers of the agent
access_infoobject or null
The access information of the agent for the user
tagslist of strings or null
Agent tags used to categorize the agent

Errors