curl -X PATCH "https://api.nedzo.ai/v1/agents/123e4567-e89b-12d3-a456-426614174000" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Agent Name",
"prompt": "Updated system prompt...",
"isActive": true,
"backgroundSound": true,
"openingLine": "Hello! How can I help you today?",
"language": "spanish",
"voicemail": false,
"voicemailMessage": "Please leave a message after the tone.",
"callDuration": 30,
"voiceId": "voice_123",
"postConversationWebhookUrl": "https://example.com/webhooks/conversation-completed"
}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Updated Agent Name",
"agentType": "Voice",
"direction": "inbound",
"prompt": "Updated system prompt...",
"isActive": true,
"backgroundSound": true,
"openingLine": "Hello! How can I help you today?",
"language": "spanish",
"voicemail": false,
"voicemailMessage": null,
"hipaaCompliance": false,
"callDuration": 30,
"speed": 1.0,
"voiceId": "voice_123",
"postConversationWebhookUrl": "https://example.com/webhooks/conversation-completed",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T11:00:00Z"
}
Agents
Update agent
Update an existing AI agent by ID via the Nedzo REST API. Modify the agent prompt, voice, language, model, actions, or knowledge base configuration.
PATCH
/
agents
/
{id}
curl -X PATCH "https://api.nedzo.ai/v1/agents/123e4567-e89b-12d3-a456-426614174000" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Agent Name",
"prompt": "Updated system prompt...",
"isActive": true,
"backgroundSound": true,
"openingLine": "Hello! How can I help you today?",
"language": "spanish",
"voicemail": false,
"voicemailMessage": "Please leave a message after the tone.",
"callDuration": 30,
"voiceId": "voice_123",
"postConversationWebhookUrl": "https://example.com/webhooks/conversation-completed"
}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Updated Agent Name",
"agentType": "Voice",
"direction": "inbound",
"prompt": "Updated system prompt...",
"isActive": true,
"backgroundSound": true,
"openingLine": "Hello! How can I help you today?",
"language": "spanish",
"voicemail": false,
"voicemailMessage": null,
"hipaaCompliance": false,
"callDuration": 30,
"speed": 1.0,
"voiceId": "voice_123",
"postConversationWebhookUrl": "https://example.com/webhooks/conversation-completed",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T11:00:00Z"
}
Update an agent’s details. All fields are optional - only provided fields will be updated.
Path Parameters
string
required
The unique UUID of the Agent
Common Fields
string
Agent name (1-255 characters)
boolean
Whether the agent is active
string
System prompt for the agent
string
Agent language. Valid values:
english, spanish, french, german, portuguese, dutch, chinese, japanesestring
deprecated
Deprecated and ignored. An agent has no direction — its number both answers and places calls. Still accepted on Voice agents so existing integrations keep working, but it does not change the agent. Sending it on a Chat or Widget agent is still rejected.
Type-Specific Fields
- Voice
- Chat
- Widget
string
Opening line the agent says when starting a conversation
string
Voice ID for text-to-speech
boolean
Enable voicemail detection. Applies to calls the agent places.
string
Message to leave on voicemail
boolean
Enable background sound
boolean
When this is enabled, no logs, recordings, or transcriptions will be stored
integer
Maximum call duration in minutes, 1-60
number
Voice speed multiplier, 0.5-1.5
string
URL to receive a POST request after each conversation ends. The payload includes the transcript, summary, outcome, duration, contact details, and extracted fields. Set to
null to disable. See the Post-conversation webhook page for the full payload.string
deprecated
Deprecated. Use
postConversationWebhookUrl instead. Still accepted on input for backwards compatibility; responses always use the new field.string
URL to receive a POST request after each chat conversation ends (SMS, Instagram, Messenger, email, or web chat). The payload includes the transcript, summary, channel, contact details, and extracted fields. Set to
null to disable. See the Post-conversation webhook page for the full payload.string
URL to receive a POST request after each web agent conversation ends. The payload includes the transcript, summary, outcome, duration, and extracted fields. Set to
null to disable. See the Post-conversation webhook page for the full payload.curl -X PATCH "https://api.nedzo.ai/v1/agents/123e4567-e89b-12d3-a456-426614174000" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Agent Name",
"prompt": "Updated system prompt...",
"isActive": true,
"backgroundSound": true,
"openingLine": "Hello! How can I help you today?",
"language": "spanish",
"voicemail": false,
"voicemailMessage": "Please leave a message after the tone.",
"callDuration": 30,
"voiceId": "voice_123",
"postConversationWebhookUrl": "https://example.com/webhooks/conversation-completed"
}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Updated Agent Name",
"agentType": "Voice",
"direction": "inbound",
"prompt": "Updated system prompt...",
"isActive": true,
"backgroundSound": true,
"openingLine": "Hello! How can I help you today?",
"language": "spanish",
"voicemail": false,
"voicemailMessage": null,
"hipaaCompliance": false,
"callDuration": 30,
"speed": 1.0,
"voiceId": "voice_123",
"postConversationWebhookUrl": "https://example.com/webhooks/conversation-completed",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T11:00:00Z"
}
Was this page helpful?