Skip to main content
PATCH
/
voice-ai
/
agents
/
{agentId}
Patch Agent
curl --request PATCH \
  --url https://services.leadconnectorhq.com/voice-ai/agents/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "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"
  ],
  "sendPostCallNotificationTo": {
    "admins": true,
    "allUsers": false,
    "contactAssignedUser": false,
    "specificUsers": [
      "user_507f1f77bcf86cd799439011"
    ],
    "customEmails": [
      "manager@company.com"
    ]
  },
  "agentWorkingHours": [
    {
      "dayOfTheWeek": 1,
      "intervals": [
        {
          "startHour": 9,
          "startMinute": 0,
          "endHour": 17,
          "endMinute": 30
        }
      ]
    }
  ],
  "timezone": "America/New_York",
  "isAgentAsBackupDisabled": false,
  "translation": {
    "enabled": false,
    "language": "es"
  }
}
'
{
  "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,
  "timezone": "America/New_York",
  "isAgentAsBackupDisabled": false,
  "inboundNumber": "+1234567890",
  "numberPoolId": "pool_507f1f77bcf86cd799439011",
  "callEndWorkflowIds": [],
  "sendPostCallNotificationTo": {
    "admins": true,
    "allUsers": false,
    "contactAssignedUser": false,
    "specificUsers": [],
    "customEmails": []
  },
  "agentWorkingHours": [],
  "translation": {
    "enabled": false,
    "language": "es"
  }
}

Authorizations

​
Authorization
string
header
required

Access Token or Private Integration Token

Headers

​
Version
enum<string>
required

API Version

Available options:
2021-04-15

Path Parameters

​
agentId
string
required

Unique agent identifier

Example:

"507f1f77bcf86cd799439011"

Query Parameters

​
locationId
string
required

Location ID

Example:

"LOC123456789ABCDEF"

Body

application/json
​
agentName
string

Display name for the voice AI agent, between 1-40 characters. Default: "My Agent {random 3 digit number}"

Required string length: 1 - 40
Example:

"Customer Support Agent"

​
businessName
string

Name of the business this agent represents. Default: Uses location name

Minimum string length: 1
Example:

"Acme Corporation"

​
welcomeMessage
string

Initial greeting spoken when the agent answers calls. Default: Auto generated

Required string length: 1 - 190
Example:

"Hello! Thank you for calling Acme Corporation. How can I assist you today?"

​
agentPrompt
string

Custom instructions defining the agent's behavior and personality. Default: Basic prompt generated automatically

Example:

"You are a helpful customer service representative. Always be polite and professional."

​
voiceId
string

Identifier for the speech synthesis voice from available voice options. Default: Auto generated

Example:

"507f1f77bcf86cd799439011"

​
language
enum<string>

Language code for the agent's speech and understanding. Default: "en-US"

Available options:
en-US,
pt-BR,
es,
fr,
de,
it,
nl-NL,
multi
Example:

"en-US"

​
patienceLevel
enum<string>

Tolerance level for caller response delays. Default: "high"

Available options:
low,
medium,
high
Example:

"low"

​
maxCallDuration
number

Maximum call duration in seconds, between 180-900 (3-15 minutes). Default: 300 seconds (5 minutes)

Required range: 180 <= x <= 900
Example:

600

​
sendUserIdleReminders
boolean

Enables automatic reminders when callers are silent. Default: true

Example:

true

​
reminderAfterIdleTimeSeconds
number

Seconds to wait before sending idle reminders, between 1-20. Default: 8 seconds

Required range: 1 <= x <= 20
Example:

5

​
inboundNumber
string

Phone number for receiving inbound calls to this agent. Default: null

Example:

"+1234567890"

​
numberPoolId
string

Identifier for the number pool managing phone number allocation. Default: null

Example:

"pool_507f1f77bcf86cd799439011"

​
callEndWorkflowIds
string[]

Array of workflow IDs to trigger automatically when calls end. Default: []

Maximum array length: 10
Example:
[
  "wf_507f1f77bcf86cd799439011",
  "wf_507f1f77bcf86cd799439012"
]
​
sendPostCallNotificationTo
object

Configuration for post-call email notifications to various recipients. Default: []

​
agentWorkingHours
object[]

Time intervals defining when the agent accepts calls, organized by day of week. Default: [] (available 24/7)

​
timezone
string

IANA timezone identifier affecting working hours and scheduling. Default: Location timezone

Pattern: ^[A-Za-z_]+/[A-Za-z_]+$
Example:

"America/New_York"

​
isAgentAsBackupDisabled
boolean

Prevents this agent from being used as a fallback option. Default: false (Available as backup agent)

Example:

false

​
translation
object

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.

Response

Agent updated successfully

​
id
string
required

Unique identifier for the created agent

Example:

"507f1f77bcf86cd799439011"

​
locationId
string
required

Unique identifier for the location where this agent operates

Example:

"LOC123456789ABCDEF"

​
agentName
string
required

Display name of the voice AI agent

Example:

"Customer Support Agent"

​
businessName
string
required

Name of the business this agent represents

Example:

"Acme Corporation"

​
welcomeMessage
string
required

Greeting message spoken when the agent answers calls

Example:

"Hello! Thank you for calling. How can I assist you today?"

​
agentPrompt
string
required

Custom instructions defining the agent's behavior

Example:

"You are a helpful customer service representative."

​
voiceId
string
required

Identifier for the speech synthesis voice being used

Example:

"507f1f77bcf86cd799439011"

​
language
string
required

Language code for the agent's speech and understanding

Example:

"en-US"

​
patienceLevel
string
required

Current tolerance level for caller response delays

Example:

"medium"

​
maxCallDuration
number
required

Maximum call duration in seconds, between 180-900

Required range: 180 <= x <= 900
Example:

600

​
sendUserIdleReminders
boolean
required

Indicates whether automatic idle reminders are enabled

Example:

true

​
reminderAfterIdleTimeSeconds
number
required

Seconds to wait before sending idle reminders, between 1-20

Required range: 1 <= x <= 20
Example:

5

​
timezone
string
required

IANA timezone identifier for working hours and scheduling

Example:

"America/New_York"

​
isAgentAsBackupDisabled
boolean
required

Indicates whether this agent is excluded from backup scenarios

Example:

false

​
inboundNumber
string

Phone number for receiving inbound calls

Example:

"+1234567890"

​
numberPoolId
string

Identifier for the number pool managing this agent's phone allocation

Example:

"pool_507f1f77bcf86cd799439011"

​
callEndWorkflowIds
string[]

Array of workflow IDs triggered automatically when calls end

Example:
[]
​
sendPostCallNotificationTo
object

Current post-call notification settings including recipient configuration

​
agentWorkingHours
object[]

Time intervals when the agent accepts calls, organized by day of week

Example:
[]
​
translation
object

Current language translation settings including enablement status and target language

Last modified on March 7, 2026