Skip to main content
PATCH
Update an agent
Anything you leave out stays as it is. Sending "description": null clears the description. Common causes of a 422 validation error:
  • name is empty or longer than 100 characters.
  • description is empty or longer than 5,000 characters.
A 400 can also mean the agent’s current voice setup is no longer valid, so any update is refused. Fix the agent’s voice in the Dashboard, then retry. See Errors.

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string<uuid>
required

The agent's id.

Body

application/json
name
string

The agent's display name. Surrounding spaces are trimmed.

Required string length: 1 - 100
Example:

"Admissions Assistant (Cairo)"

description
string | null

A short description of what the agent does. Surrounding spaces are trimmed. Send null to clear it.

Required string length: 1 - 5000
Example:

"Answers questions about enrollment and fees."

Response

The updated agent.

message
string
Example:

"Agent updated successfully"

data
object