Skip to main content
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" }'

{
  "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": [],
  "created_at": "2026-06-06T10:00:00Z",
  "updated_at": "2026-06-06T11:30:00Z"
}
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

​
agent_id
string
required
The agent’s unique identifier (UUID).

​
Body Parameters

All optional — include only what you want to change.
​
name
string
​
prompt
string
​
language
string
​
voice
string
Voice display name (Keren, Karmit, Kobi, Kfir, Dana, Dafna, Dorin, Dan, Dor, David, Sapir, Steve).
​
welcome_message
string
​
variables_provided
array
Replaces the provided-variable set. Same item shape as Create Agent.
​
variables_extracted
array
Replaces the extracted-variable set. Same item shape as Create Agent.

​
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" }'

{
  "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": [],
  "created_at": "2026-06-06T10:00:00Z",
  "updated_at": "2026-06-06T11:30:00Z"
}