Skip to main content
PATCH
Update a tool

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

What the agent calls it. Unique in the account.

Pattern: ^[a-zA-Z_][a-zA-Z0-9_]{0,63}$
Example:

"check_order_status"

description
string

Tells the agent what the tool does and when to use it.

Required string length: 1 - 1000
Example:

"Look up where an order is. Use it when the caller asks about a delivery."

parameters
object

What the agent passes when it calls the tool, as a JSON Schema object. Describe every property: the agent reads the descriptions to decide what to fill in. At most 30 properties, three levels deep.

Example:
webhook
object
client
object

Response

The updated a tool

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

"6a96a3ead6e886d42462dd3e"

object
enum<string>
required
Available options:
tool
name
string
required
description
string
required
type
enum<string>
required
Available options:
webhook,
client
parameters
object
required
webhook
object | null
required
client
object | null
required
created_at
string<date-time>
required

ISO 8601, always UTC.

Example:

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

updated_at
string<date-time>
required

ISO 8601, always UTC.

Example:

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