Update a tool
Only the fields you send are changed.
curl --request PATCH \
--url https://api.voice.wixzel.com/v1/tools/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "check_order_status",
"description": "Look up where an order is. Use it when the caller asks about a delivery.",
"parameters": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"description": "The order number the caller reads out"
}
},
"required": [
"order_id"
]
},
"webhook": {
"url": "https://api.example.com/orders/status",
"method": "POST",
"headers": [
{
"name": "Authorization",
"value": "Bearer sk_live_…"
}
],
"timeout_ms": 10000
},
"client": {
"wait_for_result": true,
"timeout_ms": 10000
}
}
'import requests
url = "https://api.voice.wixzel.com/v1/tools/{id}"
payload = {
"name": "check_order_status",
"description": "Look up where an order is. Use it when the caller asks about a delivery.",
"parameters": {
"type": "object",
"properties": { "order_id": {
"type": "string",
"description": "The order number the caller reads out"
} },
"required": ["order_id"]
},
"webhook": {
"url": "https://api.example.com/orders/status",
"method": "POST",
"headers": [
{
"name": "Authorization",
"value": "Bearer sk_live_…"
}
],
"timeout_ms": 10000
},
"client": {
"wait_for_result": True,
"timeout_ms": 10000
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'check_order_status',
description: 'Look up where an order is. Use it when the caller asks about a delivery.',
parameters: {
type: 'object',
properties: {
order_id: {type: 'string', description: 'The order number the caller reads out'}
},
required: ['order_id']
},
webhook: {
url: 'https://api.example.com/orders/status',
method: 'POST',
headers: [{name: 'Authorization', value: 'Bearer sk_live_…'}],
timeout_ms: 10000
},
client: {wait_for_result: true, timeout_ms: 10000}
})
};
fetch('https://api.voice.wixzel.com/v1/tools/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voice.wixzel.com/v1/tools/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'check_order_status',
'description' => 'Look up where an order is. Use it when the caller asks about a delivery.',
'parameters' => [
'type' => 'object',
'properties' => [
'order_id' => [
'type' => 'string',
'description' => 'The order number the caller reads out'
]
],
'required' => [
'order_id'
]
],
'webhook' => [
'url' => 'https://api.example.com/orders/status',
'method' => 'POST',
'headers' => [
[
'name' => 'Authorization',
'value' => 'Bearer sk_live_…'
]
],
'timeout_ms' => 10000
],
'client' => [
'wait_for_result' => true,
'timeout_ms' => 10000
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voice.wixzel.com/v1/tools/{id}"
payload := strings.NewReader("{\n \"name\": \"check_order_status\",\n \"description\": \"Look up where an order is. Use it when the caller asks about a delivery.\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\",\n \"description\": \"The order number the caller reads out\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"webhook\": {\n \"url\": \"https://api.example.com/orders/status\",\n \"method\": \"POST\",\n \"headers\": [\n {\n \"name\": \"Authorization\",\n \"value\": \"Bearer sk_live_…\"\n }\n ],\n \"timeout_ms\": 10000\n },\n \"client\": {\n \"wait_for_result\": true,\n \"timeout_ms\": 10000\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.voice.wixzel.com/v1/tools/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"check_order_status\",\n \"description\": \"Look up where an order is. Use it when the caller asks about a delivery.\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\",\n \"description\": \"The order number the caller reads out\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"webhook\": {\n \"url\": \"https://api.example.com/orders/status\",\n \"method\": \"POST\",\n \"headers\": [\n {\n \"name\": \"Authorization\",\n \"value\": \"Bearer sk_live_…\"\n }\n ],\n \"timeout_ms\": 10000\n },\n \"client\": {\n \"wait_for_result\": true,\n \"timeout_ms\": 10000\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voice.wixzel.com/v1/tools/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"check_order_status\",\n \"description\": \"Look up where an order is. Use it when the caller asks about a delivery.\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\",\n \"description\": \"The order number the caller reads out\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"webhook\": {\n \"url\": \"https://api.example.com/orders/status\",\n \"method\": \"POST\",\n \"headers\": [\n {\n \"name\": \"Authorization\",\n \"value\": \"Bearer sk_live_…\"\n }\n ],\n \"timeout_ms\": 10000\n },\n \"client\": {\n \"wait_for_result\": true,\n \"timeout_ms\": 10000\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "6a96a3ead6e886d42462dd3e",
"object": "tool",
"name": "<string>",
"description": "<string>",
"type": "webhook",
"parameters": {},
"webhook": {
"url": "<string>",
"method": "GET",
"header_names": [
"<string>"
],
"timeout_ms": 123
},
"client": {
"wait_for_result": true,
"timeout_ms": 123
},
"created_at": "2026-09-01T12:00:00.000Z",
"updated_at": "2026-09-01T12:00:00.000Z"
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}Authorizations
Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.
Path Parameters
^[0-9a-f]{24}$"6a96a3ead6e886d42462dd3e"
Body
What the agent calls it. Unique in the account.
^[a-zA-Z_][a-zA-Z0-9_]{0,63}$"check_order_status"
Tells the agent what the tool does and when to use it.
1 - 1000"Look up where an order is. Use it when the caller asks about a delivery."
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.
Show child attributes
Show child attributes
{
"type": "object",
"properties": {
"order_id": {
"type": "string",
"description": "The order number the caller reads out"
}
},
"required": ["order_id"]
}
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
The updated a tool
^[0-9a-f]{24}$"6a96a3ead6e886d42462dd3e"
tool webhook, client Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
ISO 8601, always UTC.
"2026-09-01T12:00:00.000Z"
ISO 8601, always UTC.
"2026-09-01T12:00:00.000Z"
curl --request PATCH \
--url https://api.voice.wixzel.com/v1/tools/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "check_order_status",
"description": "Look up where an order is. Use it when the caller asks about a delivery.",
"parameters": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"description": "The order number the caller reads out"
}
},
"required": [
"order_id"
]
},
"webhook": {
"url": "https://api.example.com/orders/status",
"method": "POST",
"headers": [
{
"name": "Authorization",
"value": "Bearer sk_live_…"
}
],
"timeout_ms": 10000
},
"client": {
"wait_for_result": true,
"timeout_ms": 10000
}
}
'import requests
url = "https://api.voice.wixzel.com/v1/tools/{id}"
payload = {
"name": "check_order_status",
"description": "Look up where an order is. Use it when the caller asks about a delivery.",
"parameters": {
"type": "object",
"properties": { "order_id": {
"type": "string",
"description": "The order number the caller reads out"
} },
"required": ["order_id"]
},
"webhook": {
"url": "https://api.example.com/orders/status",
"method": "POST",
"headers": [
{
"name": "Authorization",
"value": "Bearer sk_live_…"
}
],
"timeout_ms": 10000
},
"client": {
"wait_for_result": True,
"timeout_ms": 10000
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'check_order_status',
description: 'Look up where an order is. Use it when the caller asks about a delivery.',
parameters: {
type: 'object',
properties: {
order_id: {type: 'string', description: 'The order number the caller reads out'}
},
required: ['order_id']
},
webhook: {
url: 'https://api.example.com/orders/status',
method: 'POST',
headers: [{name: 'Authorization', value: 'Bearer sk_live_…'}],
timeout_ms: 10000
},
client: {wait_for_result: true, timeout_ms: 10000}
})
};
fetch('https://api.voice.wixzel.com/v1/tools/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voice.wixzel.com/v1/tools/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'check_order_status',
'description' => 'Look up where an order is. Use it when the caller asks about a delivery.',
'parameters' => [
'type' => 'object',
'properties' => [
'order_id' => [
'type' => 'string',
'description' => 'The order number the caller reads out'
]
],
'required' => [
'order_id'
]
],
'webhook' => [
'url' => 'https://api.example.com/orders/status',
'method' => 'POST',
'headers' => [
[
'name' => 'Authorization',
'value' => 'Bearer sk_live_…'
]
],
'timeout_ms' => 10000
],
'client' => [
'wait_for_result' => true,
'timeout_ms' => 10000
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voice.wixzel.com/v1/tools/{id}"
payload := strings.NewReader("{\n \"name\": \"check_order_status\",\n \"description\": \"Look up where an order is. Use it when the caller asks about a delivery.\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\",\n \"description\": \"The order number the caller reads out\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"webhook\": {\n \"url\": \"https://api.example.com/orders/status\",\n \"method\": \"POST\",\n \"headers\": [\n {\n \"name\": \"Authorization\",\n \"value\": \"Bearer sk_live_…\"\n }\n ],\n \"timeout_ms\": 10000\n },\n \"client\": {\n \"wait_for_result\": true,\n \"timeout_ms\": 10000\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.voice.wixzel.com/v1/tools/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"check_order_status\",\n \"description\": \"Look up where an order is. Use it when the caller asks about a delivery.\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\",\n \"description\": \"The order number the caller reads out\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"webhook\": {\n \"url\": \"https://api.example.com/orders/status\",\n \"method\": \"POST\",\n \"headers\": [\n {\n \"name\": \"Authorization\",\n \"value\": \"Bearer sk_live_…\"\n }\n ],\n \"timeout_ms\": 10000\n },\n \"client\": {\n \"wait_for_result\": true,\n \"timeout_ms\": 10000\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voice.wixzel.com/v1/tools/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"check_order_status\",\n \"description\": \"Look up where an order is. Use it when the caller asks about a delivery.\",\n \"parameters\": {\n \"type\": \"object\",\n \"properties\": {\n \"order_id\": {\n \"type\": \"string\",\n \"description\": \"The order number the caller reads out\"\n }\n },\n \"required\": [\n \"order_id\"\n ]\n },\n \"webhook\": {\n \"url\": \"https://api.example.com/orders/status\",\n \"method\": \"POST\",\n \"headers\": [\n {\n \"name\": \"Authorization\",\n \"value\": \"Bearer sk_live_…\"\n }\n ],\n \"timeout_ms\": 10000\n },\n \"client\": {\n \"wait_for_result\": true,\n \"timeout_ms\": 10000\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "6a96a3ead6e886d42462dd3e",
"object": "tool",
"name": "<string>",
"description": "<string>",
"type": "webhook",
"parameters": {},
"webhook": {
"url": "<string>",
"method": "GET",
"header_names": [
"<string>"
],
"timeout_ms": 123
},
"client": {
"wait_for_result": true,
"timeout_ms": 123
},
"created_at": "2026-09-01T12:00:00.000Z",
"updated_at": "2026-09-01T12:00:00.000Z"
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "agent_not_found",
"message": "<string>",
"request_id": "req_01HXYZ...",
"param": "<string>",
"doc_url": "<string>"
}
}
