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

Documentation Index

Fetch the complete documentation index at: https://docs.nedzo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Update an agent’s details. All fields are optional - only provided fields will be updated.

​
Path Parameters

​
id
string
required
The unique UUID of the Agent

​
Common Fields

​
name
string
Agent name (1-255 characters)
​
isActive
boolean
Whether the agent is active
​
prompt
string
System prompt for the agent
​
language
string
Agent language. Valid values: english, spanish, french, german, portuguese, dutch, chinese, japanese
​
direction
string
Call direction for Voice agents: inbound or outbound. Only applicable to Voice agents.

​
Type-Specific Fields

​
openingLine
string
Opening line the agent says when starting a conversation
​
voiceId
string
Voice ID for text-to-speech
​
voicemail
boolean
Enable voicemail detection. Typically used with outbound direction.
​
voicemailMessage
string
Message to leave on voicemail
​
backgroundSound
boolean
Enable background sound
​
hipaaCompliance
boolean
When this is enabled, no logs, recordings, or transcriptions will be stored
​
callDuration
integer
Maximum call duration in minutes, 1-60
​
speed
number
Voice speed multiplier, 0.5-1.5
​
postConversationWebhookUrl
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.
​
postCallWebhookUrl
string
deprecated
Deprecated. Use postConversationWebhookUrl instead. Still accepted on input for backwards compatibility; responses always use the new field.
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"
}