HighLevel: Conversation AI schemas

← Conversation AI operations · All schemas

Attach Action to Agent — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Created action details
data (allOf 1)	Model	All variants apply	Expand List Actions for an Agent — response body — data item
success	boolean	Required within parent	Success status of the request

Referenced models: List Actions for an Agent — response body — data item

Create an Agent — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
autoPilotMaxMessages	number	Optional	Maximum number of messages in auto-pilot mode before requiring human intervention. (max: 100, min: 1) Default: 75
businessName	string	Optional	Name of the business the agent represents.
channels	array	Optional	Communication channels the agent can operate on
channels[]	string	Each item	One of: IG, FB, SMS, WebChat, WhatsApp, Live_Chat
goal	string	Required within parent	The goal of the agent.
instructions	string	Required within parent	Instructions for the agent.
isPrimary	boolean	Optional	Indicates if this agent is a primary agent. Default: false
knowledgeBaseIds	array	Optional	Array of knowledge base IDs associated with this agent.
knowledgeBaseIds[]	string	Each item
mode	string	Optional	Mode of operation - OFF, SUGGESTIVE, or AUTO_PILOT Default: off One of: off, suggestive, auto-pilot
name	string	Required within parent	Name of the agent.
personality	string	Required within parent	Personality traits of the agent.
respondToAudio	boolean	Optional	Allow agent to respond to audio Default: false
respondToImages	boolean	Optional	Allow agent to respond to images Default: false
sleepEnabled	boolean	Optional	Indicates if sleep functionality is enabled. Default: false
sleepOnManualMessage	boolean	Optional	Enable sleep when a manual outbound message is sent.
sleepOnWorkflowMessage	boolean	Optional	Enable sleep when a workflow outbound message is sent.
sleepTime	number	Optional	Duration of sleep period (required if sleepEnabled is true). Set to null for indefinite sleep. (max 2880 for minutes, 172800 for seconds, 48 for hours)
sleepTimeUnit	string	Optional	Unit of sleep time - HOURS, MINUTES, or SECONDS (required if sleepEnabled is true). Set to null for indefinite sleep. One of: hours, minutes, seconds
waitTime	number	Optional	Wait time before agent responds (max 5 for minutes, 300 for seconds) Default: 2
waitTimeUnit	string	Optional	Unit for wait time - SECONDS or MINUTES Default: seconds One of: minutes, seconds

Create an Agent — response body

Field	Type	Presence	Description and constraints
$	object	Root
actions	array	Required within parent	List of actions associated with this agent.
actions[]	Model	Each item	Expand Create an Agent — response body — actions item
autoPilotMaxMessages	JSON	Required within parent
autoPilotMaxMessages (anyOf 1)	number	Alternative	Maximum number of messages in auto-pilot mode before requiring human intervention.
autoPilotMaxMessages (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
businessName	string	Optional	Name of the business the agent represents.
channels	array	Required within parent	Communication channels the agent operates on.
channels[]	string	Each item	Known values: IG, FB, SMS, WebChat, WhatsApp, Live_Chat
goal	string	Optional	The goal of the agent.
id	string	Required within parent	Unique identifier for the agent.
instructions	string	Optional	Instructions for the agent.
isPrimary	boolean	Required within parent	Indicates if this agent is a primary agent.
knowledgeBaseIds	array	Optional	Array of knowledge base IDs associated with this agent.
knowledgeBaseIds[]	string	Each item
mode	string	Required within parent	Current operating mode of the agent. Known values: off, suggestive, auto-pilot
name	string	Required within parent	Name of the agent.
personality	string	Optional	Personality traits of the agent.
sleepEnabled	boolean	Required within parent	Indicates if sleep functionality is enabled.
sleepOnManualMessage	boolean	Optional	Whether the bot sleeps on manual outbound messages.
sleepOnWorkflowMessage	boolean	Optional	Whether the bot sleeps on workflow outbound messages.
sleepTime	JSON	Optional
sleepTime (anyOf 1)	number	Alternative	Duration of sleep period.
sleepTime (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sleepTimeUnit	string	Optional	Unit of sleep time. Known values: hours, minutes, seconds
waitTime	JSON	Required within parent
waitTime (anyOf 1)	number	Alternative	Wait time before agent responds.
waitTime (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
waitTimeUnit	string	Required within parent	Unit for wait time. Known values: minutes, seconds

Referenced models: Create an Agent — response body — actions item

Create an Agent — response body — actions item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Unique identifier for the action.
type	string	Required within parent	type of action. Known values: triggerWorkflow, updateContactField, appointmentBooking, stopBot, humanHandOver, advancedFollowup, transferBot

Delete Agent — conversation Ai delete Agent — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Unique identifier of the deleted agent.
success	boolean	Required within parent	Indicates if the agent was deleted successfully.

Get Action by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Action details
data (allOf 1)	Model	All variants apply	Expand List Actions for an Agent — response body — data item
success	boolean	Required within parent	Success status of the request

Referenced models: List Actions for an Agent — response body — data item

Get the generation details — response body

Field	Type	Presence	Description and constraints
$	object	Root
actionLogs	array	Required within parent	List of actions taken during this interaction.
agentId	string	Optional	ID of the employee/agent that generated the response.
faqs	array	Optional	FAQ chunks used in generating the response from fine-tuned data.
history	array	Required within parent	Conversation history leading up to this response.
input	string	Optional	The original input message that triggered this response.
intent	string	Optional	The intent/goal extracted from location prompt.
mode	string	Optional	Mode of operation during this interaction.
prompt	string	Required within parent	The complete prompt used for the AI response.
responseMessage	string	Required within parent	The response message generated by the AI.
website	array	Optional	Website content chunks used in generating the response.

List Actions for an Agent — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	Grouped actions by type
data[]	Model	Each item	Expand List Actions for an Agent — response body — data item
success	boolean	Required within parent	Success status of the request

Referenced models: List Actions for an Agent — response body — data item

List Actions for an Agent — response body — data / item / details / handoverType: contact Request, lack Of Information, failed To Resolve Issue, custom, sleep Time Unit: days, hours, minutes

Field	Type	Presence	Description and constraints
$	object	Root
assignToUserId	string	Optional	ID of the user to assign the conversation to
createTask	boolean	Optional	Whether to create a task when handing over
enabled	boolean	Required within parent	Whether human handover action is enabled
examples	array	Optional	Example phrases that trigger human handover (required when handoverType is custom or contactRequest)
examples[]	string	Each item
finalMessage	string	Required within parent	Final message sent when handing over to human
handoverType	string	Required within parent	Type of human handover detection Known values: contactRequest, lackOfInformation, failedToResolveIssue, custom
reactivateEnabled	boolean	Required within parent	Whether the agent can be reactivated after handover
skipAssignToUser	boolean	Optional	Whether to skip assigning to a specific user
sleepTime	JSON	Optional
sleepTime (anyOf 1)	number	Alternative	Time duration before reactivation (required when reactivateEnabled is true)
sleepTime (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sleepTimeUnit	string	Optional	Time unit for reactivation delay (required when reactivateEnabled is true) Known values: days, hours, minutes
tags	array	Optional	Tags to apply during handover
tags[]	string	Each item
triggerCondition	string	Required within parent	Condition that triggers human handover

List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether advanced followup is enabled
followupSequence	array	Required within parent	Sequence of followup actions to perform
followupSequence[]	Model	Each item	Expand List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Sequence item
followupSettings	JSON	Optional	Additional settings for followup behavior
followupSettings (allOf 1)	Model	All variants apply	Expand List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Settings timezone To Use: contact, business
scenarioId	string	Required within parent	ID of the followup scenario Known values: contactStoppedReplying, contactIsBusy, contactRequested

Referenced models: List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Sequence item, List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Settings timezone To Use: contact, business

List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Sequence item

Field	Type	Presence	Description and constraints
$	object	Root
aiEnabledMessage	boolean	Optional	Whether to use AI to generate the followup message Default: true
contactRequested	boolean	Optional	Whether contact was requested in this followup
customMessage	string	Optional	Custom message to send (when aiEnabledMessage is false)
followupTime	JSON	Required within parent
followupTime (anyOf 1)	number	Alternative	Time duration before followup (max: 60 minutes, 24 hours, or 180 days depending on unit)
followupTime (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
followupTimeUnit	string	Required within parent	Time unit for followup delay Known values: days, hours, minutes
id	JSON	Required within parent
id (anyOf 1)	number	Alternative	Unique identifier for this followup step
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
triggerWorkflow	boolean	Optional	Whether to trigger a workflow during this followup Default: false
workflowId	string	Optional	Workflow ID to trigger (when triggerWorkflow is true)

List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Settings timezone To Use: contact, business

Field	Type	Presence	Description and constraints
$	object	Root
dynamicChannelSwitching	boolean	Required within parent	Whether to dynamically switch channels for followups Default: true
followUpHours	boolean	Optional	Whether to respect working hours for followups
timezoneToUse	string	Optional	Timezone to use for followups, contact or location Known values: contact, business
workingHours	array	Optional	Working hours configuration for followups
workingHours[]	Model	Each item	Expand List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Settings timezone To Use: contact, business working Hours item

Referenced models: List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Settings timezone To Use: contact, business working Hours item

List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Settings timezone To Use: contact, business 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 (0=Sunday, 1=Monday, etc.)
dayOfTheWeek (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
intervals	array	Optional	Time intervals for this day
intervals[]	Model	Each item	Expand List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Settings timezone To Use: contact, business working Hours item intervals item

Referenced models: List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Settings timezone To Use: contact, business working Hours item intervals item

List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Settings timezone To Use: contact, business working Hours item intervals item

Field	Type	Presence	Description and constraints
$	object	Root
endHour	JSON	Required within parent
endHour (anyOf 1)	number	Alternative	End hour (24-hour format)
endHour (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endMinute	JSON	Required within parent
endMinute (anyOf 1)	number	Alternative	End minute
endMinute (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startHour	JSON	Required within parent
startHour (anyOf 1)	number	Alternative	Start hour (24-hour format)
startHour (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startMinute	JSON	Required within parent
startMinute (anyOf 1)	number	Alternative	Start minute
startMinute (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List Actions for an Agent — response body — data / item / details / sleepTimeUnit: days, hours, minutes

Field	Type	Presence	Description and constraints
$	object	Root
actionId	string	Optional	Optional action ID reference
calendarId	string	Required within parent	Calendar ID for appointment booking
cancelEnabled	boolean	Required within parent	Whether to allow appointment cancellation (cannot be true when onlySendLink is true) Default: false
onlySendLink	boolean	Required within parent	If true, only sends the appointment link without booking
rescheduleEnabled	boolean	Required within parent	Whether to allow appointment rescheduling (cannot be true when onlySendLink is true) Default: false
sleepAfterBooking	boolean	Required within parent	Whether to put the agent to sleep after booking (cannot be true when onlySendLink is true)
sleepTime	JSON	Optional
sleepTime (anyOf 1)	number	Alternative	Sleep duration (required when sleepAfterBooking is true)
sleepTime (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sleepTimeUnit	string	Optional	Unit for sleep time (required when sleepAfterBooking is true) Known values: days, hours, minutes
transferAgent	string	Optional	Agent ID to transfer to (required when transferBot is true)
transferBot	boolean	Required within parent	Whether to transfer to another agent after booking (cannot be true when onlySendLink is true)
triggerWorkflow	boolean	Required within parent	Whether to trigger a workflow after booking (cannot be true when onlySendLink is true)
workflowIds	array	Optional	Workflow IDs to trigger after booking (required when triggerWorkflow is true)
workflowIds[]	string	Each item

List Actions for an Agent — response body — data / item / details / sleepTimeUnit: days, hours, minutes, stop Bot Detection Type: Goodbye, Custom

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether this action is enabled for the agent
finalMessage	string	Required within parent	Final message sent when stopping the bot
reactivateEnabled	boolean	Required within parent	Whether the bot can be reactivated after being stopped
sleepTime	JSON	Optional
sleepTime (anyOf 1)	number	Alternative	Time duration before reactivation (required when reactivateEnabled is true)
sleepTime (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sleepTimeUnit	string	Optional	Time unit for reactivation delay (required when reactivateEnabled is true) Known values: days, hours, minutes
stopBotDetectionType	string	Required within parent	Type of stop bot detection - Goodbye or Custom Known values: Goodbye, Custom
stopBotExamples	array	Required within parent	Example phrases that trigger stop bot action (minimum 2 required)
stopBotExamples[]	string	Each item
stopBotTriggerCondition	string	Required within parent	Condition that triggers stopping the bot
tags	array	Optional	Tags to apply when stopping the bot
tags[]	string	Each item

List Actions for an Agent — response body — data / item / details / transferBotType: Default, Custom

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether this transfer action is enabled
transferBotExamples	array	Optional	Example phrases that trigger transfer (required for Custom type, minimum 2)
transferBotExamples[]	string	Each item
transferBotTriggerCondition	string	Optional	Condition that triggers the transfer (required for Custom type)
transferBotType	string	Required within parent	Type of transfer - Default or Custom Known values: Default, Custom
transferToBot	string	Required within parent	ID of the bot/agent to transfer to

List Actions for an Agent — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
agentId	string	Optional	Agent ID where the action belongs
details	JSON	Required within parent	Action-specific details. The structure depends on the action type. For TRIGGER_WORKFLOW use triggerWorkflowDto, for UPDATE_CONTACT_FIELD use updateContactFieldDto, for APPOINTMENT_BOOKING use appointmentBookingDto, for STOP_BOT use stopBotDto, for HUMAN_HAND_OVER use humanHandOverDto, for ADVANCED_FOLLOWUP use advancedFollowupDto, and for TRANSFER_BOT use transferBotDto.
details (anyOf 1)	Model	Alternative	Expand Update Action — request body — body details trigger Condition, trigger Message, workflow Ids
details (anyOf 2)	Model	Alternative	Expand Update Action — request body — body details contact Field Id, contact Update Examples, description
details (anyOf 3)	Model	Alternative	Expand List Actions for an Agent — response body — data / item / details / sleepTimeUnit: days, hours, minutes
details (anyOf 4)	Model	Alternative	Expand List Actions for an Agent — response body — data / item / details / sleepTimeUnit: days, hours, minutes, stop Bot Detection Type: Goodbye, Custom
details (anyOf 5)	Model	Alternative	Expand List Actions for an Agent — response body — data / item / details / handoverType: contact Request, lack Of Information, failed To Resolve Issue, custom, sleep Time Unit: days, hours, minutes
details (anyOf 6)	Model	Alternative	Expand List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested
details (anyOf 7)	Model	Alternative	Expand List Actions for an Agent — response body — data / item / details / transferBotType: Default, Custom
id	string	Required within parent	Unique identifier for the action
name	string	Required within parent	Name of the action
type	string	Required within parent	Type of the action Known values: triggerWorkflow, updateContactField, appointmentBooking, stopBot, humanHandOver, advancedFollowup, transferBot

Referenced models: List Actions for an Agent — response body — data / item / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested, List Actions for an Agent — response body — data / item / details / sleepTimeUnit: days, hours, minutes, List Actions for an Agent — response body — data / item / details / handoverType: contact Request, lack Of Information, failed To Resolve Issue, custom, sleep Time Unit: days, hours, minutes, List Actions for an Agent — response body — data / item / details / sleepTimeUnit: days, hours, minutes, stop Bot Detection Type: Goodbye, Custom, List Actions for an Agent — response body — data / item / details / transferBotType: Default, Custom, Update Action — request body — body details trigger Condition, trigger Message, workflow Ids, Update Action — request body — body details contact Field Id, contact Update Examples, description

Remove Action from Agent — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Deleted action information
data (allOf 1)	Model	All variants apply	Expand Remove Action from Agent — response body — data id
success	boolean	Required within parent	Success status of the request

Referenced models: Remove Action from Agent — response body — data id

Remove Action from Agent — response body — data id

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	ID of the deleted action

Search Agents — response body

Field	Type	Presence	Description and constraints
$	object	Root
agents	array	Required within parent	List of agents matching the search criteria.
agents[]	Model	Each item	Expand Search Agents — response body — agents item
count	JSON	Required within parent
count (anyOf 1)	number	Alternative	Number of agents in the current response (filtered/paginated count).
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalCount	JSON	Required within parent
totalCount (anyOf 1)	number	Alternative	Total number of agents in the location (unfiltered count).
totalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search Agents — response body — agents item

Search Agents — response body — agents item

Field	Type	Presence	Description and constraints
$	object	Root
actions	array	Required within parent	List of actions associated with this agent.
actions[]	object	Each item
autoPilotMaxMessages	JSON	Required within parent
autoPilotMaxMessages (anyOf 1)	number	Alternative	Maximum number of messages in auto-pilot mode before requiring human intervention.
autoPilotMaxMessages (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
businessName	string	Optional	Name of the business the agent represents.
channels	array	Required within parent	Communication channels the agent operates on.
channels[]	string	Each item
createdAt	string	Required within parent	Timestamp when the agent was created.
goal	object	Optional	Goal configuration for the agent.
id	string	Required within parent	Unique identifier for the agent.
isPrimary	boolean	Required within parent	Indicates if this agent is a primary agent. (First agent created for a location is primary by default)
knowledgeBaseIds	array	Optional	Array of knowledge base IDs associated with this agent.
knowledgeBaseIds[]	string	Each item
mode	string	Required within parent	Current operating mode of the agent. Known values: off, suggestive, auto-pilot
name	string	Required within parent	Name of the agent.
sleepEnabled	boolean	Required within parent	Indicates if sleep functionality is enabled.
sleepOnManualMessage	boolean	Optional	Whether the bot sleeps on manual outbound messages.
sleepOnWorkflowMessage	boolean	Optional	Whether the bot sleeps on workflow outbound messages.
sleepTime	JSON	Optional
sleepTime (anyOf 1)	number	Alternative	Duration of sleep period.
sleepTime (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sleepTimeUnit	string	Optional	Unit of sleep time. Known values: hours, minutes, seconds
updatedAt	string	Required within parent	Timestamp when the agent was last updated.
waitTime	JSON	Required within parent
waitTime (anyOf 1)	number	Alternative	Wait time before agent responds.
waitTime (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
waitTimeUnit	string	Required within parent	Unit for wait time. Known values: minutes, seconds

Update Action — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
details	JSON	Required within parent	Action-specific details. The structure depends on the action type. For TRIGGER_WORKFLOW use triggerWorkflowDto, for UPDATE_CONTACT_FIELD use updateContactFieldDto, for APPOINTMENT_BOOKING use appointmentBookingDto, for STOP_BOT use stopBotDto, for HUMAN_HAND_OVER use humanHandOverDto, for ADVANCED_FOLLOWUP use advancedFollowupDto, and for TRANSFER_BOT use transferBotDto.
details (oneOf 1)	Model	Alternative	Expand Update Action — request body — body details trigger Condition, trigger Message, workflow Ids
details (oneOf 2)	Model	Alternative	Expand Update Action — request body — body details contact Field Id, contact Update Examples, description
details (oneOf 3)	Model	Alternative	Expand Update Action — request body — body / details / sleepTimeUnit: days, hours, minutes
details (oneOf 4)	Model	Alternative	Expand Update Action — request body — body / details / sleepTimeUnit: days, hours, minutes, stop Bot Detection Type: Goodbye, Custom
details (oneOf 5)	Model	Alternative	Expand Update Action — request body — body / details / handoverType: contact Request, lack Of Information, failed To Resolve Issue, custom, sleep Time Unit: days, hours, minutes
details (oneOf 6)	Model	Alternative	Expand Update Action — request body — body / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested
details (oneOf 7)	Model	Alternative	Expand Update Action — request body — body / details / transferBotType: Default, Custom
name	string	Required within parent
type	string	Required within parent	One of: triggerWorkflow, updateContactField, appointmentBooking, stopBot, humanHandOver, advancedFollowup, transferBot

Referenced models: Update Action — request body — body details trigger Condition, trigger Message, workflow Ids, Update Action — request body — body details contact Field Id, contact Update Examples, description, Update Action — request body — body / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested, Update Action — request body — body / details / sleepTimeUnit: days, hours, minutes, Update Action — request body — body / details / handoverType: contact Request, lack Of Information, failed To Resolve Issue, custom, sleep Time Unit: days, hours, minutes, Update Action — request body — body / details / sleepTimeUnit: days, hours, minutes, stop Bot Detection Type: Goodbye, Custom, Update Action — request body — body / details / transferBotType: Default, Custom

Update Action — request body — body / details / handoverType: contact Request, lack Of Information, failed To Resolve Issue, custom, sleep Time Unit: days, hours, minutes

Field	Type	Presence	Description and constraints
$	object	Root
assignToUserId	string	Optional	ID of the user to assign the conversation to
createTask	boolean	Optional	Whether to create a task when handing over
enabled	boolean	Required within parent	Whether human handover action is enabled
examples	array	Optional	Example phrases that trigger human handover (required when handoverType is custom or contactRequest)
examples[]	string	Each item
finalMessage	string	Required within parent	Final message sent when handing over to human
handoverType	string	Required within parent	Type of human handover detection One of: contactRequest, lackOfInformation, failedToResolveIssue, custom
reactivateEnabled	boolean	Required within parent	Whether the agent can be reactivated after handover
skipAssignToUser	boolean	Optional	Whether to skip assigning to a specific user
sleepTime	number	Optional	Time duration before reactivation (required when reactivateEnabled is true)
sleepTimeUnit	string	Optional	Time unit for reactivation delay (required when reactivateEnabled is true) One of: days, hours, minutes
tags	array	Optional	Tags to apply during handover
tags[]	string	Each item
triggerCondition	string	Required within parent	Condition that triggers human handover

Update Action — request body — body / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether advanced followup is enabled
followupSequence	array	Required within parent	Sequence of followup actions to perform
followupSequence[]	Model	Each item	Expand Update Action — request body — body / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Sequence item
followupSettings	JSON	Optional	Additional settings for followup behavior
followupSettings (allOf 1)	Model	All variants apply	Expand Update Followup Settings — request body — body followup Settings
scenarioId	string	Required within parent	ID of the followup scenario One of: contactStoppedReplying, contactIsBusy, contactRequested

Referenced models: Update Action — request body — body / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Sequence item, Update Followup Settings — request body — body followup Settings

Update Action — request body — body / details / scenarioId: contact Stopped Replying, contact Is Busy, contact Requested followup Sequence item

Field	Type	Presence	Description and constraints
$	object	Root
aiEnabledMessage	boolean	Optional	Whether to use AI to generate the followup message Default: true
contactRequested	boolean	Optional	Whether contact was requested in this followup
customMessage	string	Optional	Custom message to send (when aiEnabledMessage is false)
followupTime	number	Required within parent	Time duration before followup (max: 60 minutes, 24 hours, or 180 days depending on unit)
followupTimeUnit	string	Required within parent	Time unit for followup delay One of: days, hours, minutes
id	number	Required within parent	Unique identifier for this followup step
triggerWorkflow	boolean	Optional	Whether to trigger a workflow during this followup Default: false
workflowId	string	Optional	Workflow ID to trigger (when triggerWorkflow is true)

Update Action — request body — body / details / sleepTimeUnit: days, hours, minutes

Field	Type	Presence	Description and constraints
$	object	Root
actionId	string	Optional	Optional action ID reference
calendarId	string	Required within parent	Calendar ID for appointment booking
cancelEnabled	boolean	Required within parent	Whether to allow appointment cancellation (cannot be true when onlySendLink is true) Default: false
onlySendLink	boolean	Required within parent	If true, only sends the appointment link without booking
rescheduleEnabled	boolean	Required within parent	Whether to allow appointment rescheduling (cannot be true when onlySendLink is true) Default: false
sleepAfterBooking	boolean	Required within parent	Whether to put the agent to sleep after booking (cannot be true when onlySendLink is true)
sleepTime	number	Optional	Sleep duration (required when sleepAfterBooking is true)
sleepTimeUnit	string	Optional	Unit for sleep time (required when sleepAfterBooking is true) One of: days, hours, minutes
transferAgent	string	Optional	Agent ID to transfer to (required when transferBot is true)
transferBot	boolean	Required within parent	Whether to transfer to another agent after booking (cannot be true when onlySendLink is true)
triggerWorkflow	boolean	Required within parent	Whether to trigger a workflow after booking (cannot be true when onlySendLink is true)
workflowIds	array	Optional	Workflow IDs to trigger after booking (required when triggerWorkflow is true)
workflowIds[]	string	Each item

Update Action — request body — body / details / sleepTimeUnit: days, hours, minutes, stop Bot Detection Type: Goodbye, Custom

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether this action is enabled for the agent
finalMessage	string	Required within parent	Final message sent when stopping the bot
reactivateEnabled	boolean	Required within parent	Whether the bot can be reactivated after being stopped
sleepTime	number	Optional	Time duration before reactivation (required when reactivateEnabled is true)
sleepTimeUnit	string	Optional	Time unit for reactivation delay (required when reactivateEnabled is true) One of: days, hours, minutes
stopBotDetectionType	string	Required within parent	Type of stop bot detection - Goodbye or Custom One of: Goodbye, Custom
stopBotExamples	array	Required within parent	Example phrases that trigger stop bot action (minimum 2 required)
stopBotExamples[]	string	Each item
stopBotTriggerCondition	string	Required within parent	Condition that triggers stopping the bot
tags	array	Optional	Tags to apply when stopping the bot
tags[]	string	Each item

Update Action — request body — body / details / transferBotType: Default, Custom

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Whether this transfer action is enabled
transferBotExamples	array	Optional	Example phrases that trigger transfer (required for Custom type, minimum 2)
transferBotExamples[]	string	Each item
transferBotTriggerCondition	string	Optional	Condition that triggers the transfer (required for Custom type)
transferBotType	string	Required within parent	Type of transfer - Default or Custom One of: Default, Custom
transferToBot	string	Required within parent	ID of the bot/agent to transfer to

Update Action — request body — body details contact Field Id, contact Update Examples, description

Field	Type	Presence	Description and constraints
$	object	Root
contactFieldId	string	Required within parent	ID of the contact field in Contacts Table
contactUpdateExamples	array	Optional	Contact update examples in Contacts Table. Not required when using standard fields, Monetory or Date Custom fields. Default: []
contactUpdateExamples[]	string	Each item
description	string	Required within parent	Description of the contact field in Contacts Table

Update Action — request body — body details trigger Condition, trigger Message, workflow Ids

Field	Type	Presence	Description and constraints
$	object	Root
triggerCondition	string	Required within parent	Condition that triggers the workflow
triggerMessage	string	Optional	Optional message to send when triggering the workflow
workflowIds	array	Required within parent	Array of workflow IDs to trigger
workflowIds[]	string	Each item

Update Action — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Updated action details
data (allOf 1)	Model	All variants apply	Expand List Actions for an Agent — response body — data item
success	boolean	Required within parent	Success status of the request

Referenced models: List Actions for an Agent — response body — data item

Update Agent — conversation Ai update Agent — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
autoPilotMaxMessages	number	Required within parent	Maximum number of messages in auto-pilot mode before requiring human intervention. (max: 100, min: 1) Default: 75
businessName	string	Optional	Name of the business the agent represents.
channels	array	Optional	Channels the agent can use.
channels[]	string	Each item	One of: IG, FB, SMS, WebChat, WhatsApp, Live_Chat
goal	string	Optional	The goal of the agent.
instructions	string	Optional	Instructions for the agent.
isPrimary	boolean	Optional	Indicates if this agent is a primary agent.
knowledgeBaseIds	array	Optional	Array of knowledge base IDs associated with this agent.
knowledgeBaseIds[]	string	Each item
mode	string	Optional	Mode of operation for the agent, required if primary is enabled. One of: off, suggestive, auto-pilot
name	string	Optional	Name of the agent.
personality	string	Optional	Personality traits of the agent.
respondToAudio	boolean	Optional	Allow agent to respond to audio Default: false
respondToImages	boolean	Optional	Allow agent to respond to images Default: false
sleepEnabled	boolean	Optional	Indicates if sleep functionality is enabled.
sleepOnManualMessage	boolean	Optional	Enable sleep when a manual outbound message is sent.
sleepOnWorkflowMessage	boolean	Optional	Enable sleep when a workflow outbound message is sent.
sleepTime	number	Optional	Duration of sleep period (required if sleepEnabled is true). Set to null for indefinite sleep. (max 2880 for minutes, 172800 for seconds, 48 for hours)
sleepTimeUnit	string	Optional	Unit of sleep time - HOURS, MINUTES, or SECONDS (required if sleepEnabled is true). Set to null for indefinite sleep. One of: hours, minutes, seconds
waitTime	number	Optional	Wait time before agent responds (max 5 for minutes, 300 for seconds).
waitTimeUnit	string	Optional	Unit for wait time - SECONDS or MINUTES One of: minutes, seconds

Update Followup Settings — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
actionIds	array	Required within parent
actionIds[]	string	Each item
followupSettings	Model	Required within parent	Expand Update Followup Settings — request body — body followup Settings

Referenced models: Update Followup Settings — request body — body followup Settings

Update Followup Settings — request body — body followup Settings

Field	Type	Presence	Description and constraints
$	object	Root
dynamicChannelSwitching	boolean	Required within parent	Whether to dynamically switch channels for followups Default: true
followUpHours	boolean	Optional	Whether to respect working hours for followups
timezoneToUse	string	Optional	Timezone to use for followups, contact or location One of: contact, business
workingHours	array	Optional	Working hours configuration for followups
workingHours[]	Model	Each item	Expand Update Followup Settings — request body — body followup Settings working Hours item

Referenced models: Update Followup Settings — request body — body followup Settings working Hours item

Update Followup Settings — request body — body followup Settings working Hours item

Field	Type	Presence	Description and constraints
$	object	Root
dayOfTheWeek	number	Required within parent	Day of the week (0=Sunday, 1=Monday, etc.)
intervals	array	Optional	Time intervals for this day
intervals[]	Model	Each item	Expand Update Followup Settings — request body — body followup Settings working Hours item intervals item

Referenced models: Update Followup Settings — request body — body followup Settings working Hours item intervals item

Update Followup Settings — request body — body followup Settings working Hours item intervals item

Field	Type	Presence	Description and constraints
$	object	Root
endHour	number	Required within parent	End hour (24-hour format)
endMinute	number	Required within parent	End minute
startHour	number	Required within parent	Start hour (24-hour format)
startMinute	number	Required within parent	Start minute