Agents

Update agent metadata

View as Markdown
Update agent fields. Behavior depends on whether the agent has versioning enabled: **Versioned agents** (have an active published version): only metadata fields are accepted — `name`, `description`, `avatarUrl`, `telephonyProductId`, `allowInboundCall`, `visibleToEveryone`. Submitting any config-level field returns 400 with `"Agent has versioning enabled. Config changes must be made through drafts."`. Use `PATCH /agent/{id}/drafts/{draftId}/config` instead. **Non-versioned agents** (no active version): all configuration fields are accepted, the same full set as `POST /agent`. **400 is also returned when a cross-field constraint is violated** (for example, `north_indic` language requires `transcriberType: pulse`). **403** is returned when selecting a gated model (`gpt-5.2`, `electron-kogta`, `electron-kogta-v2`) without org-level access.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

idstringRequired

Request

This endpoint expects an object.
namestringOptional
Name of the agent.
descriptionstringOptional
Description of the agent.
avatarUrlstringOptional
URL of the agent's avatar image.
telephonyProductIdlist of stringsOptional

IDs of telephony products (phone numbers) to associate with the agent.

allowInboundCallbooleanOptional
Whether the agent accepts inbound calls.
visibleToEveryonebooleanOptional
Whether the agent is visible to all members of the organization.

Response

Agent updated successfully
statusboolean
datastring
The ID of the updated agent

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error