Documentation Index Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
Use this file to discover all available pages before exploring further.
Partially update an existing voice AI agent
PATCH https://services.leadconnectorhq.com/voice-ai/agents/{agentId}
Autorizacion Bearer token generado desde el portal Leadway. Ver Autenticacion . Version
string
default: "2021-07-28"
required
Version de la API.
Path parameters agentId
string
default: "507f1f77bcf86cd799439011"
required
Unique agent identifier
Query parameters locationId
string
default: "LOC123456789ABCDEF"
required
Account ID
Body agentName
string
default: "Customer Support Agent"
Display name for the voice AI agent, between 1-40 characters. Default: “My Agent {random 3 digit number}”
businessName
string
default: "Acme Corporation"
Name of the business this agent represents. Default: Uses account name
Initial greeting spoken when the agent answers calls. Default: Auto generated
Custom instructions defining the agent’s behavior and personality. Default: Basic prompt generated automatically
voiceId
string
default: "507f1f77bcf86cd799439011"
Identifier for the speech synthesis voice from available voice options. Default: Auto generated
Language code for the agent’s speech and understanding. Default: “en-US” Posibles valores: ‘en-US’, ‘pt-BR’, ‘es’, ‘fr’, ‘de’, ‘it’, ‘nl-NL’, ‘multi’
Tolerance level for caller response delays. Default: “high” Posibles valores: ‘low’, ‘medium’, ‘high’
Maximum call duration in seconds, between 180-900 (3-15 minutes). Default: 300 seconds (5 minutes)
Enables automatic reminders when callers are silent. Default: true
reminderAfterIdleTimeSeconds
Seconds to wait before sending idle reminders, between 1-20. Default: 8 seconds
inboundNumber
string
default: "+1234567890"
Phone number for receiving inbound calls to this agent. Default: null
numberPoolId
string
default: "pool_507f1f77bcf86cd799439011"
Identifier for the number pool managing phone number allocation. Default: null
Array of workflow IDs to trigger automatically when calls end. Default: []
sendPostCallNotificationTo
Configuration for post-call email notifications to various recipients. Default: []
Time intervals defining when the agent accepts calls, organized by day of week. Default: [] (available 24/7) dayOfTheWeek
number
default: "1"
required
Day of the week for this working hours configuration (Monday=1 to Sunday=7) Posibles valores: 1, 2, 3, 4, 5, 6, 7
Array of time intervals when the agent is available on this day startHour
number
default: "9"
required
Starting hour of the working interval in 24-hour format (0-23)
endHour
number
default: "17"
required
Ending hour of the working interval in 24-hour format (0-23)
startMinute
number
default: "0"
required
Starting minute of the working interval (0-59)
endMinute
number
default: "30"
required
Ending minute of the working interval (0-59)
timezone
string
default: "America/New_York"
IANA timezone identifier affecting working hours and scheduling. Default: Account timezone
Prevents this agent from being used as a fallback option. Default: false (Available as backup agent)
Language translation settings including enablement flag and target language code. Rules: (1) translation.enabled can only be true if the agent’s language is not en-US; (2) when enabled, translation.language must be either the agent’s language or en-US; (3) when enabled, translation.language is required.
Respuestas
200 - Agent updated successfully
id
string
default: "507f1f77bcf86cd799439011"
required
Unique identifier for the created agent
locationId
string
default: "LOC123456789ABCDEF"
required
Unique identifier for the account where this agent operates
agentName
string
default: "Customer Support Agent"
required
Display name of the voice AI agent
businessName
string
default: "Acme Corporation"
required
Name of the business this agent represents
Greeting message spoken when the agent answers calls
Custom instructions defining the agent’s behavior
voiceId
string
default: "507f1f77bcf86cd799439011"
required
Identifier for the speech synthesis voice being used
language
string
default: "en-US"
required
Language code for the agent’s speech and understanding
patienceLevel
string
default: "medium"
required
Current tolerance level for caller response delays
maxCallDuration
number
default: "600"
required
Maximum call duration in seconds, between 180-900
sendUserIdleReminders
boolean
default: "True"
required
Indicates whether automatic idle reminders are enabled
reminderAfterIdleTimeSeconds
number
default: "5"
required
Seconds to wait before sending idle reminders, between 1-20
inboundNumber
string
default: "+1234567890"
Phone number for receiving inbound calls
numberPoolId
string
default: "pool_507f1f77bcf86cd799439011"
Identifier for the number pool managing this agent’s phone allocation
Array of workflow IDs triggered automatically when calls end
sendPostCallNotificationTo
Current post-call notification settings including recipient configuration
Time intervals when the agent accepts calls, organized by day of week dayOfTheWeek
number
default: "1"
required
Day of the week for this working hours configuration (Monday=1 to Sunday=7) Posibles valores: 1, 2, 3, 4, 5, 6, 7
Array of time intervals when the agent is available on this day startHour
number
default: "9"
required
Starting hour of the working interval in 24-hour format (0-23)
endHour
number
default: "17"
required
Ending hour of the working interval in 24-hour format (0-23)
startMinute
number
default: "0"
required
Starting minute of the working interval (0-59)
endMinute
number
default: "30"
required
Ending minute of the working interval (0-59)
timezone
string
default: "America/New_York"
required
IANA timezone identifier for working hours and scheduling
isAgentAsBackupDisabled
boolean
default: "False"
required
Indicates whether this agent is excluded from backup scenarios
Current language translation settings including enablement status and target language
{ "id" : "507f1f77bcf86cd799439011" , "locationId" : "LOC123456789ABCDEF" , "agentName" : "Customer Support Agent" , "businessName" : "Acme Corporation" , "welcomeMessage" : "Hello! Thank you for calling. How can I assist you today?" , "agentPrompt" : "You are a helpful customer service representative." , "voiceId" : "507f1f77bcf86cd799439011" , "language" : "en-US" , "patienceLevel" : "medium" , "maxCallDuration" : 600 , "sendUserIdleReminders" : true , "reminderAfterIdleTimeSeconds" : 5 , "inboundNumber" : "+1234567890" , "numberPoolId" : "pool_507f1f77bcf86cd799439011" , "callEndWorkflowIds" : [], "agentWorkingHours" : [], "timezone" : "America/New_York" , "isAgentAsBackupDisabled" : false }
422 - Unprocessable Entity
Ejemplo curl -X PATCH 'https://services.leadconnectorhq.com/voice-ai/agents/YOUR_agentId' \ -H 'Authorization: Bearer YOUR_TOKEN' \ -H 'Version: 2021-07-28' \ -H 'Content-Type: application/json' \ -d '{ "agentName": "Customer Support Agent", "businessName": "Acme Corporation", "welcomeMessage": "Hello! Thank you for calling Acme Corporation. How can I assist you today?", "agentPrompt": "You are a helpful customer service representative. Always be polite and professional.", "voiceId": "507f1f77bcf86cd799439011", "language": "en-US", "patienceLevel": "low", "maxCallDuration": 600, "sendUserIdleReminders": true, "reminderAfterIdleTimeSeconds": 5, "inboundNumber": "+1234567890", "numberPoolId": "pool_507f1f77bcf86cd799439011", "callEndWorkflowIds": [ "wf_507f1f77bcf86cd799439011", "wf_507f1f77bcf86cd799439012" ], "agentWorkingHours": [ { "dayOfTheWeek": 1, "intervals": [ { "startHour": 9, "startMinute": 0, "endHour": 17, "endMinute": 30 } ] } ], "timezone": "America/New_York", "isAgentAsBackupDisabled": false }'
