Skip to main content
PATCH
Update an agent

Authorizations

Authorization
string
header
required

Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Path Parameters

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

Body

application/json
name
string
Required string length: 1 - 200
system_prompt
string

The agent's instructions. Spoken conversation, so keep it short and concrete.

Required string length: 1 - 20000
opening_message
string

Spoken as soon as the call connects. Supports {{name}} style merge fields. Required — an agent without one answers in silence.

Required string length: 1 - 1000
voice
object

Either a composed pipeline (stt + llm + tts) or a single realtime model. Not both.

language
string
default:en-US
knowledge_base_id
string
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

outbound_phone_number_id
string
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

appointment_booking_enabled
boolean
default:false

Response

The updated an agent

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

object
enum<string>
required
Available options:
agent
name
string
required
system_prompt
string
required
opening_message
string | null
required
voice
object | null
required

Either a composed pipeline (stt + llm + tts) or a single realtime model. Not both.

language
string
required
knowledge_base_id
string | null
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

outbound_phone_number_id
string | null
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

appointment_booking_enabled
boolean
required
created_at
string<date-time>
required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"