Agents

Update agent metadata

View as Markdown
Update non-versioned agent-level fields: name, description, telephony product, and inbound call settings. Agent configuration (voice, language, prompt, tools, post-call analytics, etc.) is managed through the versioning system. Submitting any config-level field here returns 400 with `"Agent has versioning enabled. Config changes must be made through drafts."` Use `PATCH /agent/{id}/drafts/{draftId}/config` instead.

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
descriptionstringOptional
telephonyProductIdstringOptional

Telephony product ID to associate with the agent for outbound/inbound calls.

allowInboundCallbooleanOptional
Whether the agent can receive inbound calls.

Response

Agent updated successfully
statusboolean
datastring
The ID of the updated agent

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error