Skip to main content
PATCH
/
v1
/
voiceai
/
agents
/
{agent_id}
Patches An Agent Settings
curl --request PATCH \
  --url https://api.example.com/v1/voiceai/agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "My agent"
}
'
{
  "agent_id": "agent_7101k5zvyjhmfg983brhmhkd98n6",
  "name": "My Agent",
  "tags": [
    "Customer Support"
  ]
}

Authorizations

​
x-api-key
string
header
required

API key for programmatic access

Path Parameters

​
agent_id
string
required

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

Example:

"agent_3701k3ttaq12ewp8b7qv5rfyszkz"

Body

application/json
​
name
string | null

A name to make the agent easier to find

Example:

"My agent"

​
conversation_config
ConversationalConfigAPIModelInput · object

Conversation configuration for an agent (partial update)

​
platform_settings
AgentPlatformSettingsRequestModel · object

Platform settings for the agent (partial update)

​
workflow
AgentWorkflowRequestModel · object

Workflow for the agent

​
tags
string[] | null

Tags to help classify and filter the agent

Example:
["Customer Support", "Technical Help"]
​
version_description
string | null

Description for this version when publishing changes

Response

Successful Response

​
agent_id
string
required

The ID of the agent

​
name
string
required

The name of the agent

​
conversation_config
ConversationalConfigAPIModel · object
required

The conversation configuration of the agent

​
metadata
AgentMetadataResponseModel · object
required

The metadata of the agent

​
platform_settings
AgentPlatformSettingsResponseModel · object

The platform settings of the agent

​
phone_numbers
(GetPhoneNumberTwilioResponseModel · object | GetPhoneNumberSIPTrunkResponseModel · object)[]

The phone numbers of the agent

Example:
{
  "label": "Customer Support",
  "phone_number": "+1234567890",
  "phone_number_id": "phone_123",
  "provider": "twilio",
  "supports_inbound": true,
  "supports_outbound": true
}
​
workflow
AgentWorkflowResponseModel · object

The workflow of the agent

​
access_info
ResourceAccessInfo · object

Access information for the user

​
tags
string[]

Agent tags for categorization