HighLevel: Voice AI schemas

← Voice AI operations · All schemas

Create Agent — voice Ai create Agent — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
agentName	string	Optional	Display name for the voice AI agent, between 1-40 characters. Default: "My Agent {random 3 digit number}" Maximum length: 40 Minimum length: 1
agentPrompt	string	Optional	Custom instructions defining the agent's behavior and personality. Default: Basic prompt generated automatically
agentWorkingHours	array	Optional	Time intervals defining when the agent accepts calls, organized by day of week. Default: [] (available 24/7)
agentWorkingHours[]	Model	Each item	Expand Patch Agent — request body — body agent Working Hours item
businessName	string	Optional	Name of the business this agent represents. Default: Uses location name Minimum length: 1
callEndWorkflowIds	array	Optional	Array of workflow IDs to trigger automatically when calls end. Default: [] Maximum items: 10
callEndWorkflowIds[]	string	Each item
inboundNumber	string	Optional	Phone number for receiving inbound calls to this agent. Default: null
isAgentAsBackupDisabled	boolean	Optional	Prevents this agent from being used as a fallback option. Default: false (Available as backup agent)
language	string	Optional	Language code for the agent's speech and understanding. Default: "en-US" One of: en-US, pt-BR, es, fr, de, it, nl-NL, multi
locationId	string	Required within parent	Unique identifier for the location where this agent will operate
maxCallDuration	number	Optional	Maximum call duration in seconds, between 180-900 (3-15 minutes). Default: 300 seconds (5 minutes) Maximum: 900 Minimum: 180
numberPoolId	string	Optional	Identifier for the number pool managing phone number allocation. Default: null
patienceLevel	string	Optional	Tolerance level for caller response delays. Default: "high" One of: low, medium, high
reminderAfterIdleTimeSeconds	number	Optional	Seconds to wait before sending idle reminders, between 1-20. Default: 8 seconds Maximum: 20 Minimum: 1
sendPostCallNotificationTo	JSON	Optional	Configuration for post-call email notifications to various recipients. Default: []
sendPostCallNotificationTo (allOf 1)	Model	All variants apply	Expand Patch Agent — request body — body send Post Call Notification To admins, all Users, contact Assigned User, custom Emails, specific Users
sendUserIdleReminders	boolean	Optional	Enables automatic reminders when callers are silent. Default: true
timezone	string	Optional	IANA timezone identifier affecting working hours and scheduling. Default: Location timezone Pattern: ^[A-Za-z_]+/[A-Za-z_]+$
translation	JSON	Optional	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.
translation (allOf 1)	Model	All variants apply	Expand Patch Agent — request body — body translation enabled, language
voiceId	string	Optional	Identifier for the speech synthesis voice from available voice options. Default: Auto generated
welcomeMessage	string	Optional	Initial greeting spoken when the agent answers calls. Default: Auto generated Maximum length: 190 Minimum length: 1

Referenced models: Patch Agent — request body — body agent Working Hours item, Patch Agent — request body — body send Post Call Notification To admins, all Users, contact Assigned User, custom Emails, specific Users, Patch Agent — request body — body translation enabled, language

List Agents — voice Ai get Agents — response body

Field	Type	Presence	Description and constraints
$	object	Root
agents	array	Required within parent
agents[]	Model	Each item	Expand List Agents — voice Ai get Agents — response body — agents item
page	JSON	Required within parent
page (anyOf 1)	number	Alternative	Page number starting from 1
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSize	JSON	Required within parent
pageSize (anyOf 1)	number	Alternative	Number of items per page
pageSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total number of items
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Agents — voice Ai get Agents — response body — agents item

List Agents — voice Ai get Agents — response body — agents item

Field	Type	Presence	Description and constraints
$	object	Root
actions	array	Required within parent	Raw actions configured for this agent with complete actionParameters structure
actions[]	Model	Each item	Expand List Agents — voice Ai get Agents — response body — agents item actions item
agentName	string	Required within parent	Display name of the voice AI agent
agentPrompt	string	Required within parent	Custom instructions defining the agent's behavior
agentWorkingHours	array	Optional	Time intervals when the agent accepts calls, organized by day of week
agentWorkingHours[]	Model	Each item	Expand Patch Agent — response body — agent Working Hours item
businessName	string	Required within parent	Name of the business this agent represents
callEndWorkflowIds	array	Optional	Array of workflow IDs triggered automatically when calls end
callEndWorkflowIds[]	string	Each item
id	string	Required within parent	Unique identifier for the created agent
inboundNumber	string	Optional	Phone number for receiving inbound calls
isAgentAsBackupDisabled	boolean	Required within parent	Indicates whether this agent is excluded from backup scenarios
language	string	Required within parent	Language code for the agent's speech and understanding
locationId	string	Required within parent	Unique identifier for the location where this agent operates
maxCallDuration	JSON	Required within parent
maxCallDuration (anyOf 1)	number	Alternative	Maximum call duration in seconds, between 180-900 Maximum: 900 Minimum: 180
maxCallDuration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
numberPoolId	string	Optional	Identifier for the number pool managing this agent's phone allocation
patienceLevel	string	Required within parent	Current tolerance level for caller response delays
reminderAfterIdleTimeSeconds	JSON	Required within parent
reminderAfterIdleTimeSeconds (anyOf 1)	number	Alternative	Seconds to wait before sending idle reminders, between 1-20 Maximum: 20 Minimum: 1
reminderAfterIdleTimeSeconds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sendPostCallNotificationTo	JSON	Optional	Current post-call notification settings including recipient configuration
sendPostCallNotificationTo (allOf 1)	Model	All variants apply	Expand Patch Agent — response body — send Post Call Notification To admins, all Users, contact Assigned User, custom Emails, specific Users
sendUserIdleReminders	boolean	Required within parent	Indicates whether automatic idle reminders are enabled
timezone	string	Required within parent	IANA timezone identifier for working hours and scheduling
translation	JSON	Optional	Current language translation settings including enablement status and target language
translation (allOf 1)	Model	All variants apply	Expand Patch Agent — response body — translation enabled, language
voiceId	string	Required within parent	Identifier for the speech synthesis voice being used
welcomeMessage	string	Required within parent	Greeting message spoken when the agent answers calls

Referenced models: List Agents — voice Ai get Agents — response body — agents item actions item, Patch Agent — response body — agent Working Hours item, Patch Agent — response body — send Post Call Notification To admins, all Users, contact Assigned User, custom Emails, specific Users, Patch Agent — response body — translation enabled, language

List Agents — voice Ai get Agents — response body — agents item actions item

Field	Type	Presence	Description and constraints
$	object	Root
actionParameters	JSON	Required within parent	Action parameters - structure varies by actionType
actionParameters (anyOf 1)	Model	Alternative	Expand List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / transferToType: number
actionParameters (anyOf 2)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters contact Field Id, description, examples, overwrite Existing Value
actionParameters (anyOf 3)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters contact Field Id, description, examples, overwrite Existing Value
actionParameters (anyOf 4)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters trigger Message, trigger Prompt, workflow Id
actionParameters (anyOf 5)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters message Body, trigger Message, trigger Prompt
actionParameters (anyOf 6)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters calendar Id, days Of Offering Dates, hours Between Slots, slots Per Day
actionParameters (anyOf 7)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters api Details, selected Paths, trigger Message, trigger Prompt
actionParameters (anyOf 8)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters knowledge Base Id, trigger Prompt
actionType	string	Required within parent	Type of action Known values: CALL_TRANSFER, DATA_EXTRACTION, IN_CALL_DATA_EXTRACTION, WORKFLOW_TRIGGER, SMS, APPOINTMENT_BOOKING, CUSTOM_ACTION, KNOWLEDGE_BASE
id	string	Required within parent	Unique identifier for this action
name	string	Required within parent	Human-readable name for this action

Referenced models: List Agents — voice Ai get Agents — response body — agents item actions item action Parameters contact Field Id, description, examples, overwrite Existing Value, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters knowledge Base Id, trigger Prompt, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters calendar Id, days Of Offering Dates, hours Between Slots, slots Per Day, List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / transferToType: number, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters api Details, selected Paths, trigger Message, trigger Prompt, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters message Body, trigger Message, trigger Prompt, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters trigger Message, trigger Prompt, workflow Id

List Agents — voice Ai get Agents — response body — agents item actions item action Parameters api Details, selected Paths, trigger Message, trigger Prompt

Field	Type	Presence	Description and constraints
$	object	Root
apiDetails	JSON	Required within parent	API endpoint configuration
apiDetails (allOf 1)	Model	All variants apply	Expand List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / apiDetails, selectedPaths, triggerMessage, triggerPrompt / apiDetails / method: POST, GET
selectedPaths	array	Optional	Selected response paths to extract from API response. Required: at least 1 value if the method is GET. Should be empty if the method is POST.
selectedPaths[]	string	Each item
triggerMessage	string	Required within parent	Message to tell the caller
triggerPrompt	string	Required within parent	When to call the custom API

Referenced models: List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / apiDetails, selectedPaths, triggerMessage, triggerPrompt / apiDetails / method: POST, GET

List Agents — voice Ai get Agents — response body — agents item actions item action Parameters calendar Id, days Of Offering Dates, hours Between Slots, slots Per Day

Field	Type	Presence	Description and constraints
$	object	Root
calendarId	string	Required within parent	Calendar ID to book appointments in
daysOfOfferingDates	JSON	Required within parent
daysOfOfferingDates (anyOf 1)	number	Alternative	Number of days ahead to offer booking dates
daysOfOfferingDates (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hoursBetweenSlots	JSON	Required within parent
hoursBetweenSlots (anyOf 1)	number	Alternative	Hours between available slots
hoursBetweenSlots (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
slotsPerDay	JSON	Required within parent
slotsPerDay (anyOf 1)	number	Alternative	Number of available slots per day
slotsPerDay (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List Agents — voice Ai get Agents — response body — agents item actions item action Parameters contact Field Id, description, examples, overwrite Existing Value

Field	Type	Presence	Description and constraints
$	object	Root
contactFieldId	string	Required within parent	ID of the contact field to be updated with the extracted data
description	string	Required within parent	Description of what data to extract
examples	array	Required within parent	Example values to help Agent understand the expected format. At least one example is required, maximum 5 examples allowed.
examples[]	string	Each item
overwriteExistingValue	boolean	Optional	Whether to overwrite existing field value if already set, default is false Default: false

List Agents — voice Ai get Agents — response body — agents item actions item action Parameters knowledge Base Id, trigger Prompt

Field	Type	Presence	Description and constraints
$	object	Root
knowledgeBaseId	string	Required within parent	Knowledge base ID to query
triggerPrompt	string	Required within parent	When to query the knowledge base

List Agents — voice Ai get Agents — response body — agents item actions item action Parameters message Body, trigger Message, trigger Prompt

Field	Type	Presence	Description and constraints
$	object	Root
messageBody	string	Required within parent	SMS message content to send
triggerMessage	string	Required within parent	Message to tell the caller
triggerPrompt	string	Required within parent	When to send the SMS

List Agents — voice Ai get Agents — response body — agents item actions item action Parameters trigger Message, trigger Prompt, workflow Id

Field	Type	Presence	Description and constraints
$	object	Root
triggerMessage	string	Required within parent	Message to tell the caller
triggerPrompt	string	Required within parent	When to trigger this workflow
workflowId	string	Required within parent	Workflow ID to trigger

List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / apiDetails, selectedPaths, triggerMessage, triggerPrompt / apiDetails / method: POST, GET

Field	Type	Presence	Description and constraints
$	object	Root
authenticationRequired	boolean	Optional	Whether authentication is required
authenticationValue	string	Optional	Authentication token or API key (required if authenticationRequired is true)
headers	array	Optional	HTTP headers to include
headers[]	Model	Each item	Expand List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / apiDetails, selectedPaths, triggerMessage, triggerPrompt / apiDetails / method: POST, GET headers item
method	string	Required within parent	HTTP method Known values: POST, GET
parameters	array	Optional	API parameters to send
parameters[]	Model	Each item	Expand List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / apiDetails, selectedPaths, triggerMessage, triggerPrompt / apiDetails / method: POST, GET parameters item
url	string	Required within parent	API endpoint URL

Referenced models: List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / apiDetails, selectedPaths, triggerMessage, triggerPrompt / apiDetails / method: POST, GET headers item, List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / apiDetails, selectedPaths, triggerMessage, triggerPrompt / apiDetails / method: POST, GET parameters item

List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / apiDetails, selectedPaths, triggerMessage, triggerPrompt / apiDetails / method: POST, GET headers item

Field	Type	Presence	Description and constraints
$	object	Root
key	string	Required within parent	HTTP header name
value	string	Required within parent	HTTP header value

List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / apiDetails, selectedPaths, triggerMessage, triggerPrompt / apiDetails / method: POST, GET parameters item

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	Parameter description
example	string	Optional	Example parameter value
name	string	Required within parent	Parameter name
type	string	Optional	Parameter type

List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / transferToType: number

Field	Type	Presence	Description and constraints
$	object	Root
hearWhisperMessage	boolean	Optional	Whether to play whisper message to the receiving party
transferToType	string	Required within parent	Type of transfer destination (currently only "number" is supported) Known values: number
transferToValue	string	Required within parent	Phone number to transfer to. Must start with +, include country code, contain only numbers, and be 11-16 characters long (e.g., +12345678901).
triggerMessage	string	Required within parent	Message to tell the caller before transferring
triggerPrompt	string	Required within parent	When to trigger this action during the call

List Call Logs — response body

Field	Type	Presence	Description and constraints
$	object	Root
callLogs	array	Required within parent	Array of call logs
callLogs[]	Model	Each item	Expand List Call Logs — response body — call Logs item
page	JSON	Required within parent
page (anyOf 1)	number	Alternative	Page number starting from 1
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageSize	JSON	Required within parent
pageSize (anyOf 1)	number	Alternative	Number of items per page
pageSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total number of items
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Call Logs — response body — call Logs item

List Call Logs — response body — call Logs item

Field	Type	Presence	Description and constraints
$	object	Root
agentId	string	Required within parent	Agent ID associated with the call
contactId	string	Optional	Associated contact ID
createdAt	string	Required within parent	Timestamp when the call was created Format: date-time
duration	JSON	Required within parent
duration (anyOf 1)	number	Alternative	Call duration in seconds
duration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
executedCallActions	array	Required within parent	Actions performed during the call. Note: The APPOINTMENT_BOOKING action will only be visible in executedCallActions from Sep 9th 2025.
executedCallActions[]	Model	Each item	Expand List Call Logs — response body — call Logs item executed Call Actions item
extractedData	JSON	Optional	Dynamic data extracted from the call based on agent configuration Additional keys: allowed
extractedData (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
fromNumber	string	Optional	Caller phone number
id	string	Required within parent	Unique identifier for the call
isAgentDeleted	boolean	Required within parent	Whether the agent is deleted
messageId	string	Optional	Message identifier associated with the call
summary	string	Required within parent	Call summary
transcript	string	Required within parent	Call transcript
translation	JSON	Optional	Transcript translation details
translation (allOf 1)	Model	All variants apply	Expand Patch Agent — response body — translation enabled, language
trialCall	boolean	Required within parent	Whether this call was a trial call

Referenced models: Delete Event — request body — body, List Call Logs — response body — call Logs item executed Call Actions item, Patch Agent — response body — translation enabled, language

List Call Logs — response body — call Logs item executed Call Actions item

Field	Type	Presence	Description and constraints
$	object	Root
actionId	string	Optional	Action ID reference
actionName	string	Required within parent	Action name
actionParameters	JSON	Optional	Action parameters - structure varies by actionType
actionParameters (anyOf 1)	Model	Alternative	Expand List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / transferToType: number
actionParameters (anyOf 2)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters contact Field Id, description, examples, overwrite Existing Value
actionParameters (anyOf 3)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters contact Field Id, description, examples, overwrite Existing Value
actionParameters (anyOf 4)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters trigger Message, trigger Prompt, workflow Id
actionParameters (anyOf 5)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters message Body, trigger Message, trigger Prompt
actionParameters (anyOf 6)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters calendar Id, days Of Offering Dates, hours Between Slots, slots Per Day
actionParameters (anyOf 7)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters api Details, selected Paths, trigger Message, trigger Prompt
actionParameters (anyOf 8)	Model	Alternative	Expand List Agents — voice Ai get Agents — response body — agents item actions item action Parameters knowledge Base Id, trigger Prompt
actionType	string	Required within parent	Action type Known values: CALL_TRANSFER, DATA_EXTRACTION, IN_CALL_DATA_EXTRACTION, WORKFLOW_TRIGGER, SMS, APPOINTMENT_BOOKING, CUSTOM_ACTION, KNOWLEDGE_BASE
executedAt	string	Optional	When the action was executed Format: date-time
triggerReceivedAt	string	Optional	When the trigger was received Format: date-time

Referenced models: List Agents — voice Ai get Agents — response body — agents item actions item action Parameters contact Field Id, description, examples, overwrite Existing Value, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters knowledge Base Id, trigger Prompt, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters calendar Id, days Of Offering Dates, hours Between Slots, slots Per Day, List Agents — voiceAi.getAgents — response body — agents / item / actions / item / actionParameters / transferToType: number, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters api Details, selected Paths, trigger Message, trigger Prompt, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters message Body, trigger Message, trigger Prompt, List Agents — voice Ai get Agents — response body — agents item actions item action Parameters trigger Message, trigger Prompt, workflow Id

Patch Agent — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
agentName	string	Optional	Display name for the voice AI agent, between 1-40 characters. Default: "My Agent {random 3 digit number}" Maximum length: 40 Minimum length: 1
agentPrompt	string	Optional	Custom instructions defining the agent's behavior and personality. Default: Basic prompt generated automatically
agentWorkingHours	array	Optional	Time intervals defining when the agent accepts calls, organized by day of week. Default: [] (available 24/7)
agentWorkingHours[]	Model	Each item	Expand Patch Agent — request body — body agent Working Hours item
businessName	string	Optional	Name of the business this agent represents. Default: Uses location name Minimum length: 1
callEndWorkflowIds	array	Optional	Array of workflow IDs to trigger automatically when calls end. Default: [] Maximum items: 10
callEndWorkflowIds[]	string	Each item
inboundNumber	string	Optional	Phone number for receiving inbound calls to this agent. Default: null
isAgentAsBackupDisabled	boolean	Optional	Prevents this agent from being used as a fallback option. Default: false (Available as backup agent)
language	string	Optional	Language code for the agent's speech and understanding. Default: "en-US" One of: en-US, pt-BR, es, fr, de, it, nl-NL, multi
maxCallDuration	number	Optional	Maximum call duration in seconds, between 180-900 (3-15 minutes). Default: 300 seconds (5 minutes) Maximum: 900 Minimum: 180
numberPoolId	string	Optional	Identifier for the number pool managing phone number allocation. Default: null
patienceLevel	string	Optional	Tolerance level for caller response delays. Default: "high" One of: low, medium, high
reminderAfterIdleTimeSeconds	number	Optional	Seconds to wait before sending idle reminders, between 1-20. Default: 8 seconds Maximum: 20 Minimum: 1
sendPostCallNotificationTo	JSON	Optional	Configuration for post-call email notifications to various recipients. Default: []
sendPostCallNotificationTo (allOf 1)	Model	All variants apply	Expand Patch Agent — request body — body send Post Call Notification To admins, all Users, contact Assigned User, custom Emails, specific Users
sendUserIdleReminders	boolean	Optional	Enables automatic reminders when callers are silent. Default: true
timezone	string	Optional	IANA timezone identifier affecting working hours and scheduling. Default: Location timezone Pattern: ^[A-Za-z_]+/[A-Za-z_]+$
translation	JSON	Optional	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.
translation (allOf 1)	Model	All variants apply	Expand Patch Agent — request body — body translation enabled, language
voiceId	string	Optional	Identifier for the speech synthesis voice from available voice options. Default: Auto generated
welcomeMessage	string	Optional	Initial greeting spoken when the agent answers calls. Default: Auto generated Maximum length: 190 Minimum length: 1

Referenced models: Patch Agent — request body — body agent Working Hours item, Patch Agent — request body — body send Post Call Notification To admins, all Users, contact Assigned User, custom Emails, specific Users, Patch Agent — request body — body translation enabled, language

Patch Agent — request body — body agent Working Hours item

Field	Type	Presence	Description and constraints
$	object	Root
dayOfTheWeek	number	Required within parent	Day of the week for this working hours configuration (Monday=1 to Sunday=7) One of: 1, 2, 3, 4, 5, 6, 7
intervals	array	Required within parent	Array of time intervals when the agent is available on this day
intervals[]	Model	Each item	Expand Patch Agent — request body — body agent Working Hours item intervals item

Referenced models: Patch Agent — request body — body agent Working Hours item intervals item

Patch Agent — request body — body agent Working Hours item intervals item

Field	Type	Presence	Description and constraints
$	object	Root
endHour	number	Required within parent	Ending hour of the working interval in 24-hour format (0-23) Maximum: 23 Minimum: 0
endMinute	number	Required within parent	Ending minute of the working interval (0-59) Maximum: 59 Minimum: 0
startHour	number	Required within parent	Starting hour of the working interval in 24-hour format (0-23) Maximum: 23 Minimum: 0
startMinute	number	Required within parent	Starting minute of the working interval (0-59) Maximum: 59 Minimum: 0

Patch Agent — request body — body send Post Call Notification To admins, all Users, contact Assigned User, custom Emails, specific Users

Field	Type	Presence	Description and constraints
$	object	Root
admins	boolean	Required within parent	Enables post-call notifications to all admin users in the location. Default: true
allUsers	boolean	Required within parent	Enables post-call notifications to all users in the location. Default: false
contactAssignedUser	boolean	Required within parent	Enables post-call notifications to the user assigned to the contact. Default: false
customEmails	array	Required within parent	Array of custom email addresses to receive post-call notifications. Default: []
customEmails[]	string	Each item
specificUsers	array	Required within parent	Array of specific user IDs to receive post-call notifications. Default: []
specificUsers[]	string	Each item

Patch Agent — request body — body translation enabled, language

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Enables language translation for agent conversations. Default: false
language	string	Optional	Target language code for translation (e.g., "es" for Spanish, "fr" for French).

Patch Agent — response body

Field	Type	Presence	Description and constraints
$	object	Root
agentName	string	Required within parent	Display name of the voice AI agent
agentPrompt	string	Required within parent	Custom instructions defining the agent's behavior
agentWorkingHours	array	Optional	Time intervals when the agent accepts calls, organized by day of week
agentWorkingHours[]	Model	Each item	Expand Patch Agent — response body — agent Working Hours item
businessName	string	Required within parent	Name of the business this agent represents
callEndWorkflowIds	array	Optional	Array of workflow IDs triggered automatically when calls end
callEndWorkflowIds[]	string	Each item
id	string	Required within parent	Unique identifier for the created agent
inboundNumber	string	Optional	Phone number for receiving inbound calls
isAgentAsBackupDisabled	boolean	Required within parent	Indicates whether this agent is excluded from backup scenarios
language	string	Required within parent	Language code for the agent's speech and understanding
locationId	string	Required within parent	Unique identifier for the location where this agent operates
maxCallDuration	JSON	Required within parent
maxCallDuration (anyOf 1)	number	Alternative	Maximum call duration in seconds, between 180-900 Maximum: 900 Minimum: 180
maxCallDuration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
numberPoolId	string	Optional	Identifier for the number pool managing this agent's phone allocation
patienceLevel	string	Required within parent	Current tolerance level for caller response delays
reminderAfterIdleTimeSeconds	JSON	Required within parent
reminderAfterIdleTimeSeconds (anyOf 1)	number	Alternative	Seconds to wait before sending idle reminders, between 1-20 Maximum: 20 Minimum: 1
reminderAfterIdleTimeSeconds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sendPostCallNotificationTo	JSON	Optional	Current post-call notification settings including recipient configuration
sendPostCallNotificationTo (allOf 1)	Model	All variants apply	Expand Patch Agent — response body — send Post Call Notification To admins, all Users, contact Assigned User, custom Emails, specific Users
sendUserIdleReminders	boolean	Required within parent	Indicates whether automatic idle reminders are enabled
timezone	string	Required within parent	IANA timezone identifier for working hours and scheduling
translation	JSON	Optional	Current language translation settings including enablement status and target language
translation (allOf 1)	Model	All variants apply	Expand Patch Agent — response body — translation enabled, language
voiceId	string	Required within parent	Identifier for the speech synthesis voice being used
welcomeMessage	string	Required within parent	Greeting message spoken when the agent answers calls

Referenced models: Patch Agent — response body — agent Working Hours item, Patch Agent — response body — send Post Call Notification To admins, all Users, contact Assigned User, custom Emails, specific Users, Patch Agent — response body — translation enabled, language

Patch Agent — response body — agent Working Hours item

Field	Type	Presence	Description and constraints
$	object	Root
dayOfTheWeek	JSON	Required within parent
dayOfTheWeek (anyOf 1)	number	Alternative	Day of the week for this working hours configuration (Monday=1 to Sunday=7) Known values: 1, 2, 3, 4, 5, 6, 7
dayOfTheWeek (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
intervals	array	Required within parent	Array of time intervals when the agent is available on this day
intervals[]	Model	Each item	Expand Patch Agent — response body — agent Working Hours item intervals item

Referenced models: Patch Agent — response body — agent Working Hours item intervals item

Patch Agent — response body — agent Working Hours item intervals item

Field	Type	Presence	Description and constraints
$	object	Root
endHour	JSON	Required within parent
endHour (anyOf 1)	number	Alternative	Ending hour of the working interval in 24-hour format (0-23) Maximum: 23 Minimum: 0
endHour (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endMinute	JSON	Required within parent
endMinute (anyOf 1)	number	Alternative	Ending minute of the working interval (0-59) Maximum: 59 Minimum: 0
endMinute (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startHour	JSON	Required within parent
startHour (anyOf 1)	number	Alternative	Starting hour of the working interval in 24-hour format (0-23) Maximum: 23 Minimum: 0
startHour (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startMinute	JSON	Required within parent
startMinute (anyOf 1)	number	Alternative	Starting minute of the working interval (0-59) Maximum: 59 Minimum: 0
startMinute (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Patch Agent — response body — send Post Call Notification To admins, all Users, contact Assigned User, custom Emails, specific Users

Field	Type	Presence	Description and constraints
$	object	Root
admins	boolean	Optional	Send notifications to admins
allUsers	boolean	Optional	Send notifications to all users
contactAssignedUser	boolean	Optional	Send notifications to contact assigned user
customEmails	array	Optional	Custom email addresses to notify
customEmails[]	string	Each item
specificUsers	array	Optional	Specific user IDs to notify
specificUsers[]	string	Each item

Patch Agent — response body — translation enabled, language

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Optional	Whether translation is enabled
language	string	Optional	Translation language code