curl -X PATCH https://api.voicy.co/functions/v1/agent-modify/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer voicy_sk_live_xxx" \
-H "Content-Type: application/json" \
-d '{ "prompt": "You are a friendly receptionist. Always confirm the date twice.", "voice": "Dafna" }'
const id = '550e8400-e29b-41d4-a716-446655440000';
const agent = await (await fetch(`https://api.voicy.co/functions/v1/agent-modify/${id}`, {
method: 'PATCH',
headers: {
'Authorization': 'Bearer voicy_sk_live_xxx',
'Content-Type': 'application/json',
},
body: JSON.stringify({ prompt: 'Always confirm the date twice.', voice: 'Dafna' }),
})).json();
import requests
agent_id = '550e8400-e29b-41d4-a716-446655440000'
agent = requests.patch(
f'https://api.voicy.co/functions/v1/agent-modify/{agent_id}',
headers={'Authorization': 'Bearer voicy_sk_live_xxx'},
json={'prompt': 'Always confirm the date twice.', 'voice': 'Dafna'},
).json()
{
"agent_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Appointment Booker",
"language": "he",
"voice": "Dafna",
"agent_type": "singlePrompt",
"active": true,
"prompt": "You are a friendly receptionist. Always confirm the date twice.",
"welcome_message": "שלום, איך אפשר לעזור?",
"variables_provided": [],
"variables_extracted": [],
"webhooks": [],
"created_at": "2026-06-06T10:00:00Z",
"updated_at": "2026-06-06T11:30:00Z"
}
{
"status": "error",
"message": "Only singlePrompt agents can be modified via the API. Edit conversationalFlow agents in the dashboard."
}
Agents
Update Agent
Update a prompt-based voice agent
PATCH
/
v1
/
agent-modify
/
{agent_id}
curl -X PATCH https://api.voicy.co/functions/v1/agent-modify/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer voicy_sk_live_xxx" \
-H "Content-Type: application/json" \
-d '{ "prompt": "You are a friendly receptionist. Always confirm the date twice.", "voice": "Dafna" }'
const id = '550e8400-e29b-41d4-a716-446655440000';
const agent = await (await fetch(`https://api.voicy.co/functions/v1/agent-modify/${id}`, {
method: 'PATCH',
headers: {
'Authorization': 'Bearer voicy_sk_live_xxx',
'Content-Type': 'application/json',
},
body: JSON.stringify({ prompt: 'Always confirm the date twice.', voice: 'Dafna' }),
})).json();
import requests
agent_id = '550e8400-e29b-41d4-a716-446655440000'
agent = requests.patch(
f'https://api.voicy.co/functions/v1/agent-modify/{agent_id}',
headers={'Authorization': 'Bearer voicy_sk_live_xxx'},
json={'prompt': 'Always confirm the date twice.', 'voice': 'Dafna'},
).json()
{
"agent_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Appointment Booker",
"language": "he",
"voice": "Dafna",
"agent_type": "singlePrompt",
"active": true,
"prompt": "You are a friendly receptionist. Always confirm the date twice.",
"welcome_message": "שלום, איך אפשר לעזור?",
"variables_provided": [],
"variables_extracted": [],
"webhooks": [],
"created_at": "2026-06-06T10:00:00Z",
"updated_at": "2026-06-06T11:30:00Z"
}
{
"status": "error",
"message": "Only singlePrompt agents can be modified via the API. Edit conversationalFlow agents in the dashboard."
}
Updates a prompt-based agent and deploys the change immediately. Only the fields
you include in the body are changed.
Flow agents cannot be modified via the API —
PATCH on a conversationalFlow
agent returns 422. Edit flow agents in the dashboard.Path Parameters
string
required
The agent’s unique identifier (UUID).
Body Parameters
All optional — include only what you want to change.string
string
string
string
Voice display name (
Sapir, Steve, Sivan, Saar, Ori, Yael, Guy, Gefen, Gal, Gabriel).string
array
Replaces the provided-variable set. Same item shape as Create Agent.
array
Replaces the extracted-variable set. Same item shape as Create Agent.
array
Replaces the agent’s webhook list (up to 5). A webhook you leave out is
deleted;
Secrets and header values are never returned, so sending back the
[] removes them all. Omit the field to leave webhooks unchanged.
Same item shape as Create Agent, plus:Show Updating an existing webhook
Show Updating an existing webhook
string
The
id from the Agent response, to update that webhook in place. Without
an id, or with an id the agent no longer has, an existing webhook with
the same url is updated; otherwise a new one is created.string
Omit or send
null to keep the current secret. Send "" to remove it.object
Omit or send
null to keep the current headers. Send {} to remove them.
When set, replaces all headers.webhooks
array from a GET response leaves every webhook unchanged.Response
The updated Agent object.curl -X PATCH https://api.voicy.co/functions/v1/agent-modify/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer voicy_sk_live_xxx" \
-H "Content-Type: application/json" \
-d '{ "prompt": "You are a friendly receptionist. Always confirm the date twice.", "voice": "Dafna" }'
const id = '550e8400-e29b-41d4-a716-446655440000';
const agent = await (await fetch(`https://api.voicy.co/functions/v1/agent-modify/${id}`, {
method: 'PATCH',
headers: {
'Authorization': 'Bearer voicy_sk_live_xxx',
'Content-Type': 'application/json',
},
body: JSON.stringify({ prompt: 'Always confirm the date twice.', voice: 'Dafna' }),
})).json();
import requests
agent_id = '550e8400-e29b-41d4-a716-446655440000'
agent = requests.patch(
f'https://api.voicy.co/functions/v1/agent-modify/{agent_id}',
headers={'Authorization': 'Bearer voicy_sk_live_xxx'},
json={'prompt': 'Always confirm the date twice.', 'voice': 'Dafna'},
).json()
{
"agent_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Appointment Booker",
"language": "he",
"voice": "Dafna",
"agent_type": "singlePrompt",
"active": true,
"prompt": "You are a friendly receptionist. Always confirm the date twice.",
"welcome_message": "שלום, איך אפשר לעזור?",
"variables_provided": [],
"variables_extracted": [],
"webhooks": [],
"created_at": "2026-06-06T10:00:00Z",
"updated_at": "2026-06-06T11:30:00Z"
}
{
"status": "error",
"message": "Only singlePrompt agents can be modified via the API. Edit conversationalFlow agents in the dashboard."
}