Zoho: Cadences schemas

← Cadences operations · All schemas

Activate Cadence — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for activating one or more Cadences. Additional keys: not allowed

Cadence — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for updating the configuration of one or more existing Cadences. Additional keys: not allowed
cadences	array	Required within parent	Represents the list of Cadences to update. Maximum items: 1
cadences[]	object	Each item	Represents the updated configuration for a single Cadence. Additional keys: not allowed
cadences[].description	string	Optional	Represents the updated description of the Cadence. Maximum length: 500
cadences[].execution_details	object	Optional	Represents the updated execution frequency and unenrollment configuration for the Cadence. Additional keys: not allowed
cadences[].execution_details.unenroll_properties	array	Optional	Represents the updated conditions under which records are automatically unenrolled from the Cadence. Maximum items: 200
cadences[].execution_details.unenroll_properties[]	Model	Each item	Expand Cadence — request body — body cadences item execution details unenroll properties item
cadences[].follow_ups	array	Optional	Represents the updated list of follow-up steps for the Cadence. Maximum items: 100
cadences[].follow_ups[]	Model	Each item	Expand Cadence — request body — body cadences item follow ups item
cadences[].id	string	Optional	Represents the unique identifier of the Cadence to update. Maximum length: 255
cadences[].name	string	Optional	Represents the updated name of the Cadence. Maximum length: 100

Referenced models: Cadence — request body — body cadences item follow ups item, Cadence — request body — body cadences item execution details unenroll properties item

Cadence — request body — body / cadences / item / follow_ups / item / action / type: email notifications

Field	Type	Presence	Description and constraints
$	object	Root	Represents the follow-up step configuration for an email notification action in a Cadence. Additional keys: not allowed
id	string	Optional	Represents the unique identifier of the email notification action. Maximum length: 255
type	string	Required within parent	Represents the action type for this follow-up step. One of: email_notifications

Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call

Field	Type	Presence	Description and constraints
$	object	Root	Represents the follow-up step configuration for a scheduled call action in a Cadence. Additional keys: not allowed
details	Model	Optional	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details Action configuration carrying module+layout+field_mappings for creating the Call record.
id	string	Optional	Represents the unique identifier of the scheduled call action in the Cadence. Maximum length: 255
type	string	Required within parent	Represents the action type for this follow-up step. One of: schedule_call

Referenced models: Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details

Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details

Field	Type	Presence	Description and constraints
$	object	Root	PURPOSE: Details object for schedule_call action. Creates a Call record when workflow fires. PREREQUISITES: GET /settings/layouts?module=Calls for layout + mandatory fields. GET /settings/fields?module=Calls for field ids. MANDATORY: module ({api_name: 'Calls', id}), layout ({id}), field_mappings (array 1-25, include Subject, Call_Type). OPTIONAL: apply_restriction (bool). KEY FIELDS: Subject, Call_Type ('Outbound'|'Inbound'|'Missed'), Call_Purpose, Call_Start_Time, Remind_At. Additional keys: not allowed
apply_restriction	boolean or null	Optional	Whether to enforce assignment-threshold rules (record count limits per user) on the record owner when creating the Call record. When true, the system checks whether the owner has reached their record limit before creating the record. Only effective when the org has assignment thresholds configured. Default: false
field_mappings	array	Required within parent	Field mappings for the new Call. Each entry: {"field": {"api_name": "Subject"}, "type": "static", "value": "Follow-up"}. Must include all mandatory fields from GET /settings/layouts?module=Calls. Call_Type is system-mandatory (values: "Outbound", "Inbound", "Missed") - omitting returns REQUIRED_DATA_NOT_FOUND. Common fields: Subject, Call_Type, Call_Purpose, Call_Start_Time, Remind_At. Mapping types: static - literal values for text, picklist fields; NOT for DateTime/ALARM (DEPENDENT_MISMATCH). merge_field - runtime tokens like ${!Leads.Phone} for text-based fields; NOT for lookup/owner (DEPENDENT_MISMATCH). execution_time - REQUIRED for Call_Start_Time and Remind_At; sign required for datetime; periods: days, business_days, hours, minutes. Maximum items: 25 Minimum items: 1
field_mappings[]	Model	Each item	Expand Create an Automation Task — request body — body tasks item field mappings item Represents a single field-to-value mapping entry for the new Call record, conforming to the AutomationFieldMappings schema. Each entry identifies a target Call field and specifies the value resolution strategy: static for literal values, merge_field for runtime token substitution, or execution_time for dynamically resolved DateTime and ALARM fields.
id	string	Optional	Server-generated unique identifier for this schedule call action. Present only in GET responses; not required in POST requests. Maximum length: 20
layout	Model	Required within parent	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details layout Layout to use when creating the Call record. Determines which fields are available and their validation rules. Fetch valid layouts from GET /settings/layouts?module=Calls. The layout.id is required.
module	Model	Required within parent	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details module Target module for the call. Must be the Calls module. Provide either api_name ("Calls") or the Calls module id.

Referenced models: Create an Automation Task — request body — body tasks item field mappings item, Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details layout, Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details module

Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details layout

Field	Type	Presence	Description and constraints
$	object	Root	PURPOSE: Layout reference for create_record, add_meeting, schedule_call actions. MANDATORY: id (string). Determines field availability and validation rules. GET /settings/layouts?module={api_name} to discover. Additional keys: not allowed
display_label	string	Optional	Human-readable label of the layout. Present in GET responses. Maximum length: 50
id	string	Required within parent	Unique layout ID. Required. Obtain from GET /settings/layouts?module={module_api_name}. Maximum length: 20
name	string or null	Optional	Display name of the layout. Optional in requests; present in GET responses. Maximum length: 50

Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details module

Field	Type	Presence	Description and constraints
$	object	Root	PURPOSE: Module reference used across non-associate actions. At least one of api_name or id required (EXPECTED_FIELD_MISSING if neither). If both given, must match (AMBIGUITY_DURING_PROCESSING). GET /settings/modules to discover. Always use full 19-digit module ID. Minimum fields: 1 Additional keys: not allowed
api_name	string	Optional	API name of the module (e.g., Leads, Contacts, Deals, Vendors). Maximum length: 255
id	string	Optional	Unique module ID (19-digit format). Always use the full ID as returned by GET /settings/modules - truncated or shortened IDs return INVALID_DATA ('the tabId given seems to be invalid'). Optional in requests if api_name is provided; always present in responses. Maximum length: 20

Cadence — request body — body / cadences / item / follow_ups / item / action / type: tasks

Field	Type	Presence	Description and constraints
$	object	Root	Represents the follow-up step configuration for a task action in a Cadence. Additional keys: not allowed
id	string	Optional	Represents the unique identifier of the task action. Maximum length: 255
type	string	Required within parent	Represents the action type for this follow-up step. One of: tasks

Cadence — request body — body / cadences / item / follow_ups / item / action / type: whatsapp message notification

Field	Type	Presence	Description and constraints
$	object	Root	Represents the follow-up step configuration for a WhatsApp message notification action in a Cadence. Additional keys: not allowed
id	string	Optional	Represents the unique identifier of the WhatsApp message notification action. Maximum length: 255
type	string	Required within parent	Represents the action type for this follow-up step. One of: whatsapp_message_notification

Cadence — request body — body cadences item execution details unenroll properties item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the unenrollment condition configuration for a Cadence. Additional keys: not allowed
details	object or null	Optional	Represents the additional details for the unenrollment condition.
type	string	Required within parent	Represents the type of unenrollment condition for the Cadence. Possible values: automatic_unenroll - Unenroll records automatically based on the configured condition. end_date - Unenroll records when the specified end date is reached. criteria - Unenroll records that meet the specified criteria. followup_criteria - Unenroll records based on follow-up criteria. One of: automatic_unenroll, end_date, criteria, followup_criteria

Cadence — request body — body cadences item follow ups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a follow-up action in a Cadence, including its configuration, execution timing, and trigger conditions. Additional keys: not allowed
action	Model	Optional	Expand Cadence — request body — body cadences item follow ups item action Cadence followup action (Required)
execute_after	Model	Optional	Expand Cadence — request body — body cadences item follow ups item execute after Cadence followup execute_after
id	string	Optional	Represents the unique identifier of the follow-up action. Maximum length: 255
parent_follow_up	object	Optional	Represents the parent follow-up action in the Cadence sequence. Additional keys: not allowed
parent_follow_up.id	string	Optional	Represents the unique identifier of the parent follow-up action. Maximum length: 255
parent_follow_up.reference_id	string	Optional	Represents the reference identifier of the parent follow-up action. Maximum length: 255
reference_id	string	Optional	Represents the reference identifier of the follow-up action. Maximum length: 255
triggers	array	Optional	Represents the list of trigger conditions that initiate this follow-up action. Maximum items: 500
triggers[]	string	Each item	Represents a trigger condition for the follow-up action. Maximum length: 255

Referenced models: Cadence — request body — body cadences item follow ups item action, Cadence — request body — body cadences item follow ups item execute after

Cadence — request body — body cadences item follow ups item action

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents a follow-up action in a Cadence, including its type, identifier, and configuration details.
$ (anyOf 1)	Model	Alternative	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: tasks
$ (anyOf 2)	Model	Alternative	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: email notifications
$ (anyOf 3)	Model	Alternative	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call
$ (anyOf 4)	Model	Alternative	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: whatsapp message notification

Referenced models: Cadence — request body — body / cadences / item / follow_ups / item / action / type: tasks, Cadence — request body — body / cadences / item / follow_ups / item / action / type: email notifications, Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call, Cadence — request body — body / cadences / item / follow_ups / item / action / type: whatsapp message notification

Cadence — request body — body cadences item follow ups item execute after

Field	Type	Presence	Description and constraints
$	object	Root	Represents the execution delay configuration for a follow-up action, specifying the period unit and numeric value. Additional keys: not allowed
period	string	Required within parent	Represents the time unit for the follow-up execution delay. Possible values: minutes - Execution delay in minutes. hours - Execution delay in hours. business_hours - Execution delay in business hours. days - Execution delay in days. business_days - Execution delay in business days. months - Execution delay in months. One of: minutes, hours, business_hours, days, business_days, months
unit	integer	Required within parent	Represents the numeric value of the execution delay, expressed in the specified period unit. Format: int32 Maximum: 99 Minimum: 1

Cadence — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response returned after a Cadence operation is completed successfully. Additional keys: not allowed
cadences	array	Optional	Represents the list of Cadences with their result status from the operation. Maximum items: 100
cadences[]	Model	Each item	Expand Cadence — response body — cadences item

Referenced models: Cadence — response body — cadences item

Cadence — response body — cadences item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single Cadence operation result, including the result code, message, status, and details. Additional keys: not allowed
code	string	Optional	Represents the result code for the individual Cadence record operation. Maximum length: 255
details	Model	Optional	Expand Cadence — response body — cadences item details
message	string	Optional	Represents the result message for the individual Cadence record operation. Maximum length: 255
status	string	Optional	Represents the result status for the individual Cadence record operation. Maximum length: 255

Referenced models: Cadence — response body — cadences item details

Cadence — response body — cadences item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the nested details of a Cadence operation result, including follow-up actions and resource identifiers. Additional keys: not allowed
draft_cadence	object	Optional	Represents the draft version of the Cadence associated with the operation. Additional keys: not allowed
draft_cadence.id	string	Optional	Represents the unique identifier of the draft Cadence. Maximum length: 255
follow_ups	JSON	Optional
follow_ups (anyOf 1)	null	Alternative	Represents the list of follow-up actions involved in the operation. Maximum items: 100
follow_ups (anyOf 1)[]	Model	Each item	Expand Cadence — response body — cadences item details follow ups null item
follow_ups (anyOf 2)	array	Alternative	Represents the list of follow-up actions involved in the operation. Maximum items: 100
follow_ups (anyOf 2)[]	Model	Each item	Expand Cadence — response body — cadences item details follow ups null item
id	string	Optional	Represents the unique identifier of the resource associated with the operation. Maximum length: 255

Referenced models: Cadence — response body — cadences item details follow ups null item

Cadence — response body — cadences item details follow ups null item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a follow-up action, including its identifier and associated action details. Additional keys: not allowed
action	object	Optional	Represents the action associated with the follow-up item. Additional keys: not allowed
action.id	string	Optional	Represents the unique identifier of the follow-up action. Maximum length: 255
action.type	string	Optional	Represents the type of the follow-up action. Maximum length: 255
id	string	Optional	Represents the unique identifier of the follow-up item. Maximum length: 255

Clone a Cadence — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for cloning an existing Cadence. Additional keys: not allowed
cadences	array	Required within parent	Represents the list of Cadences to clone. Maximum items: 1
cadences[]	object	Each item	Represents the configuration for the cloned Cadence. Additional keys: not allowed
cadences[].custom_view	object	Optional	Represents the Custom View associated with the Cadence enrollment. Additional keys: not allowed
cadences[].custom_view.id	string	Required within parent	Represents the unique identifier of the Custom View. Maximum length: 255
cadences[].description	string	Optional	Represents the description of the cloned Cadence. Maximum length: 500
cadences[].execution_details	object	Optional	Represents the execution frequency details for the Cadence. Additional keys: not allowed
cadences[].execution_details.execute_every	Model	Optional	Expand Create cadence — request body — body cadences item execution details execute every
cadences[].module	Model	Required within parent	Expand Get Cadence analytics — response body — cadences item module
cadences[].name	string	Required within parent	Represents the name of the cloned Cadence. Maximum length: 100
cadences[].type	string	Required within parent	Represents the enrollment type of the Cadence. Possible values: custom_view - Automatically enrolls records matching a Custom View. manual_enrollment - Allows manual enrollment of records into the Cadence. One of: custom_view, manual_enrollment

Referenced models: Create cadence — request body — body cadences item execution details execute every, Get Cadence analytics — response body — cadences item module

Create cadence — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for creating a new Cadence with follow-up steps and action configurations. Additional keys: not allowed
cadences	array	Required within parent	Represents the list of Cadences to create. Maximum items: 1
cadences[]	object	Each item	Represents the configuration for the new Cadence, including its follow-up steps, execution details, and enrollment settings. Additional keys: not allowed
cadences[].custom_view	object	Optional	Represents the Custom View used for automatic record enrollment in the Cadence. Additional keys: not allowed
cadences[].custom_view.id	string	Required within parent	Represents the unique identifier of the Custom View. Format: int64 Maximum length: 255
cadences[].description	string	Optional	Represents the description of the Cadence. Maximum length: 500
cadences[].execution_details	object	Optional	Represents the execution frequency and unenrollment configuration for the Cadence. Additional keys: not allowed
cadences[].execution_details.execute_every	Model	Optional	Expand Create cadence — request body — body cadences item execution details execute every
cadences[].execution_details.unenroll_properties	array	Optional	Represents the conditions under which records are automatically unenrolled from the Cadence. Maximum items: 200
cadences[].execution_details.unenroll_properties[]	Model	Each item	Expand Cadence — request body — body cadences item execution details unenroll properties item
cadences[].follow_ups	array	Optional	Represents the list of follow-up steps configured for the Cadence. Maximum items: 100
cadences[].follow_ups[]	object	Each item	Represents a single follow-up step in the Cadence, including its action and trigger configuration. Additional keys: not allowed
cadences[].follow_ups[].action	Model	Required within parent	Expand Cadence — request body — body cadences item follow ups item action Cadence followup action (Required)
cadences[].follow_ups[].execute_after	Model	Optional	Expand Cadence — request body — body cadences item follow ups item execute after
cadences[].follow_ups[].parent_follow_up	object	Optional	Represents the parent follow-up step that this step branches from. Additional keys: not allowed
cadences[].follow_ups[].parent_follow_up.reference_id	string	Optional	Represents the reference identifier of the parent follow-up step. Maximum length: 255
cadences[].follow_ups[].reference_id	string	Optional	Represents the unique reference identifier for the follow-up step within the Cadence. Maximum length: 255
cadences[].follow_ups[].triggers	array	Optional	Represents the list of trigger conditions that determine when this follow-up step executes. Maximum items: 500
cadences[].follow_ups[].triggers[]	string	Each item	Represents a single trigger condition for the follow-up step. Maximum length: 255
cadences[].id	string	Optional	Represents the unique identifier of the Cadence. Maximum length: 255
cadences[].module	Model	Required within parent	Expand Get Cadence analytics — response body — cadences item module
cadences[].name	string	Required within parent	Represents the name of the Cadence. Maximum length: 100
cadences[].type	string	Required within parent	Represents the enrollment type of the Cadence. Possible values: custom_view - Automatically enrolls records matching a Custom View. manual_enrollment - Allows manual enrollment of records into the Cadence. One of: custom_view, manual_enrollment

Referenced models: Cadence — request body — body cadences item follow ups item action, Cadence — request body — body cadences item follow ups item execute after, Create cadence — request body — body cadences item execution details execute every, Get Cadence analytics — response body — cadences item module, Cadence — request body — body cadences item execution details unenroll properties item

Create cadence — request body — body cadences item execution details execute every

Field	Type	Presence	Description and constraints
$	object or null	Root	Represents the recurring execution interval for a Cadence, specifying the frequency period and numeric value. Additional keys: not allowed
period	string	Required within parent	Represents the frequency interval for recurring Cadence execution. Possible values: immediately - Execute immediately after each enrollment trigger. hours - Execute at the specified number of hours interval. days - Execute at the specified number of days interval. weeks - Execute at the specified number of weeks interval. One of: immediately, hours, days, weeks
unit	integer	Optional	Represents the numeric value of the execution interval, expressed in the specified period unit. Format: int32 Maximum: 99 Minimum: 1

Get Cadence analytics — response body — cadences item created by

Field	Type	Presence	Description and constraints
$	object	Root	Represents the identifier and name of the user who created the record. Additional keys: not allowed
id	string	Optional	Represents the unique identifier of the user who created the record. Maximum length: 255
name	string	Optional	Represents the full name of the user who created the record. Maximum length: 255

Get Cadence analytics — response body — cadences item module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the API name and identifier of a CRM module. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the CRM module. Maximum length: 255
id	string	Optional	Represents the unique identifier of the CRM module. Format: int64 Maximum length: 255

Get Cadence records count — response body — cadences records count

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response containing the count of records enrolled in each Cadence. Additional keys: not allowed
cadences_records_count	array	Optional	Represents the list of Cadences with their corresponding record counts. Maximum items: 100
cadences_records_count[]	JSON	Each item	Represents the record count details for a single Cadence.
cadences_records_count[] (anyOf 1)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item
cadences_records_count[] (anyOf 2)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error

Referenced models: Get Cadence records count — response body — cadences records count cadences records count item status error, Get Cadence records count — response body — cadences records count cadences records count item

Get Cadence records count — response body — cadences records count cadences records count item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the record count data for a Cadence, including the Cadence identifier and the number of enrolled records. Additional keys: not allowed
cadences	object	Optional	Represents the identifier and name details of the Cadence. Additional keys: not allowed
cadences.id	string	Optional	Represents the unique identifier of a Cadence. Maximum length: 255
cadences.name	string	Optional	Represents the name of a Cadence. Maximum length: 100
count	JSON	Optional
count (anyOf 1)	integer	Alternative	Represents the number of records currently enrolled in the Cadence. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Cadence records count — response body — cadences records count cadences records count item status error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error response returned when the API request fails due to validation errors or unsupported operations. Additional keys: not allowed
code	string	Required within parent	Represents a machine-readable error code; branch on this value, not on message. Known values: EXPECTED_FIELD_MISSING, INVALID_DATA, MANDATORY_NOT_FOUND, DEPENDENT_MISMATCH, NOT_ALLOWED, NO_PERMISSION, ALREADY_ACTIVATED, ALREADY_DEACTIVATED, LIMIT_EXCEEDED, NOT_SUPPORTED, DEPENDENT_FIELD_MISSING, AMBIGUITY_DURING_PROCESSING, EXPECTED_DEPENDENT_FIELD_MISSING, ALREADY_USED, DUPLICATE_DATA, INVALID_MODULE, REQUIRED_PARAM_MISSING, DEPENDENT_PARAM_MISSING
details	JSON	Required within parent	Represents additional details providing context about the error.
details (anyOf 1)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details expected fields
details (anyOf 2)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details dependee, expected fields
details (anyOf 3)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details api name, id, json path
details (anyOf 4)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, param name, supported values
details (anyOf 5)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details api name, expected data type, json path, param name
details (anyOf 6)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details api name, expected data type, json path, param name, supported values
details (anyOf 7)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, param name
details (anyOf 8)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details api name, dependee, expected data type, json path, param name, supported values
details (anyOf 9)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details api name, dependee, json path, param name
details (anyOf 10)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details resource path index
details (anyOf 11)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details id
details (anyOf 12)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details param name
details (anyOf 13)	Model	Alternative	Expand Get Cadence records count — response body — cadences_records_count / cadences_records_count / item / status error / details / param_name: ids
details (anyOf 14)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details api name, limit
details (anyOf 15)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details permissions
details (anyOf 16)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details object
details (anyOf 17)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, limit
details (anyOf 18)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details ambiguity due to
details (anyOf 19)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details api name, exists in, json path
details (anyOf 20)	Model	Alternative	Expand Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, maximum length
message	string	Required within parent	Represents the error message describing the validation failure. Format: error message
status	string	Required within parent	Represents the status of the API response. Must equal: error

Referenced models: Get Cadence records count — response body — cadences records count cadences records count item status error details ambiguity due to, Get Cadence records count — response body — cadences records count cadences records count item status error details api name, exists in, json path, Get Cadence records count — response body — cadences records count cadences records count item status error details api name, id, json path, Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, param name, supported values, Get Cadence records count — response body — cadences records count cadences records count item status error details api name, dependee, json path, param name, Get Cadence records count — response body — cadences records count cadences records count item status error details api name, dependee, expected data type, json path, param name, supported values, Get Cadence records count — response body — cadences records count cadences records count item status error details permissions, Get Cadence records count — response body — cadences records count cadences records count item status error details object, Get Cadence records count — response body — cadences records count cadences records count item status error details dependee, expected fields, Get Cadence records count — response body — cadences records count cadences records count item status error details expected fields, Get Cadence records count — response body — cadences records count cadences records count item status error details id, Get Cadence records count — response body — cadences records count cadences records count item status error details api name, expected data type, json path, param name, Get Cadence records count — response body — cadences records count cadences records count item status error details api name, expected data type, json path, param name, supported values, Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, param name, Get Cadence records count — response body — cadences records count cadences records count item status error details api name, limit, Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, limit, Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, maximum length, Get Cadence records count — response body — cadences records count cadences records count item status error details param name, Get Cadence records count — response body — cadences_records_count / cadences_records_count / item / status error / details / param_name: ids, Get Cadence records count — response body — cadences records count cadences records count item status error details resource path index

Get Cadence records count — response body — cadences records count cadences records count item status error details ambiguity due to

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details for ambiguity, listing the fields that caused the ambiguity. Additional keys: not allowed
ambiguity_due_to	array	Required within parent	Represents the list of fields that caused the ambiguity during processing. Maximum items: 100
ambiguity_due_to[]	object	Each item	Represents a field that contributed to the ambiguity, identified by its API name and JSON path. Additional keys: not allowed
ambiguity_due_to[].api_name	string	Optional	Represents the API name of the field that caused the ambiguity. Maximum length: 255
ambiguity_due_to[].json_path	string	Optional	Represents the JSON path of the field that caused the ambiguity. Maximum length: 255

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, dependee, expected data type, json path, param name, supported values

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a dependent field value does not match the expected values based on the parent field. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the field with the dependency mismatch. Maximum length: 255
dependee	object	Required within parent	Represents the dependee field associated with the mismatch. Additional keys: not allowed
dependee.api_name	string	Required within parent	Represents the API name of the dependee field. Maximum length: 255
dependee.json_path	string	Required within parent	Represents the JSON path of the dependee field. Maximum length: 500
expected_data_type	string	Optional	Represents the data type the server expected for the dependent field based on the parent field's value. Maximum length: 255
json_path	string	Optional	Represents the JSON path of the field with the dependency mismatch. Maximum length: 500
param_name	string	Optional	Represents the parameter name associated with the field. Maximum length: 255
supported_values	array	Optional	Represents the list of supported values for the dependee field. Maximum items: 25
supported_values[]	string	Each item	Represents a supported value for the dependee field. Maximum length: 500
$ (anyOf 1)	JSON	Alternative	Represents the variant of DependentMismatchDetails in which the allowed values for the dependent field are conveyed through the supported_values list.
$ (anyOf 1).supported_values	array	Required within parent	Represents the list of allowed values for the dependent field given the parent field's current value. Maximum items: 25
$ (anyOf 1).supported_values[]	string	Each item	Represents an allowed value for the dependent field. Maximum length: 500
$ (anyOf 2)	JSON	Alternative	Represents the variant of DependentMismatchDetails in which the expected data type for the dependent field is conveyed through expected_data_type.
$ (anyOf 2).expected_data_type	string	Required within parent	Represents the data type expected for the dependent field given the parent field's current value. Maximum length: 255

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, dependee, json path, param name

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a required dependency field is missing from the request. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the field with the missing dependency. Maximum length: 255
dependee	object	Required within parent	Represents the dependee field that is required but missing from the request. Additional keys: not allowed
dependee.api_name	string	Optional	Represents the API name of the dependee field. Maximum length: 255
dependee.json_path	string	Optional	Represents the JSON path of the dependee field. Maximum length: 500
dependee.param_name	string	Optional	Represents the parameter name of the dependee field. Maximum length: 255
json_path	string	Optional	Represents the JSON path of the field with the missing dependency. Maximum length: 500
param_name	string	Optional	Represents the parameter name associated with the field. Maximum length: 255

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, exists in, json path

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when an API name already exists at the specified JSON path. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field that already exists in the specified JSON path. Maximum length: 255
exists_in	object	Required within parent	Represents the location where the API name already exists, identified by its API name and JSON path. Additional keys: not allowed
exists_in.api_name	string	Optional	Represents the API name at the existing location. Maximum length: 255
exists_in.json_path	string	Optional	Represents the JSON path of the existing field location. Maximum length: 500
json_path	string	Required within parent	Represents the JSON path of the duplicate field in the request payload. Maximum length: 500

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, expected data type, json path, param name

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a field contains invalid data, specifying the expected data type. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the field with invalid data. Maximum length: 255
expected_data_type	string	Required within parent	Represents the expected data type for the field. Maximum length: 255
json_path	string	Optional	Represents the JSON path of the field with invalid data. Maximum length: 500
param_name	string	Optional	Represents the parameter name of the field with invalid data. Maximum length: 255

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, expected data type, json path, param name, supported values

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a field contains invalid data, specifying the expected data type and supported values. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the field with invalid data. Maximum length: 255
expected_data_type	string	Required within parent	Represents the expected data type for the field. Maximum length: 255
json_path	string	Optional	Represents the JSON path of the field with invalid data. Maximum length: 500
param_name	string	Optional	Represents the parameter name of the field with invalid data. Maximum length: 255
supported_values	array	Required within parent	Represents the list of supported values for the field. Maximum items: 25
supported_values[]	string	Each item	Represents a supported value for the field. Maximum length: 500

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, id, json path

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a field contains an invalid identifier. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field with invalid data. Maximum length: 255
id	string	Required within parent	Represents the identifier of the invalid value provided. Maximum length: 255
json_path	string	Required within parent	Represents the JSON path of the field with invalid data. Maximum length: 500

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, limit

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a field at a specific JSON path exceeds its maximum allowed count. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field that exceeded the limit. Maximum length: 255
json_path	string	Required within parent	Represents the JSON path of the field that exceeded the limit. Maximum length: 500
limit	JSON	Required within parent
limit (anyOf 1)	integer	Alternative	Represents the maximum allowed count for the field. Format: int32
limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, maximum length

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a field value exceeds the maximum allowed length. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field that exceeded the maximum length. Maximum length: 255
json_path	string	Required within parent	Represents the JSON path of the field that exceeded the maximum length. Maximum length: 500
maximum_length	JSON	Required within parent
maximum_length (anyOf 1)	integer	Alternative	Represents the maximum allowed length for the field. Format: int32
maximum_length (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, param name

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a mandatory field contains invalid data. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the mandatory field with invalid data. Maximum length: 255
json_path	string	Required within parent	Represents the JSON path of the mandatory field with invalid data. Maximum length: 500
param_name	string	Optional	Represents the parameter name of the mandatory field with invalid data. Maximum length: 255

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, json path, param name, supported values

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a field contains an invalid value, listing the supported values. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field with invalid data. Maximum length: 255
json_path	string	Required within parent	Represents the JSON path of the field with invalid data. Maximum length: 500
param_name	string	Optional	Represents the parameter name of the field with invalid data. Maximum length: 255
supported_values	array	Required within parent	Represents the list of supported values for the field. Maximum items: 25
supported_values[]	string	Each item	Represents a supported value for the field. Maximum length: 500

Get Cadence records count — response body — cadences records count cadences records count item status error details api name, limit

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when a field exceeds its maximum allowed count. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the field that exceeded the limit. Maximum length: 255
limit	JSON	Required within parent
limit (anyOf 1)	integer	Alternative	Represents the maximum allowed count for the field. Format: int32
limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Cadence records count — response body — cadences records count cadences records count item status error details dependee, expected fields

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when expected dependent fields are missing from the request. Additional keys: not allowed
dependee	object	Required within parent	Represents the expected dependent field that is missing from the request. Additional keys: not allowed
dependee.api_name	string	Required within parent	Represents the API name of the expected dependent field. Maximum length: 255
dependee.json_path	string	Required within parent	Represents the JSON path of the expected dependent field. Maximum length: 500
expected_fields	array	Required within parent	Represents the list of expected fields that are missing from the request. Maximum items: 25
expected_fields[]	object	Each item	Represents a missing expected field, identified by its API name and JSON path. Additional keys: not allowed
expected_fields[].api_name	string	Required within parent	Represents the API name of the missing expected field. Maximum length: 255
expected_fields[].json_path	string	Required within parent	Represents the JSON path of the missing expected field. Maximum length: 500

Get Cadence records count — response body — cadences records count cadences records count item status error details expected fields

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when expected fields are missing from the request. Additional keys: not allowed
expected_fields	array	Required within parent	Represents the list of expected fields that are missing from the request. Maximum items: 25
expected_fields[]	object	Each item	Represents a missing expected field, identified by its API name and JSON path. Additional keys: not allowed
expected_fields[].api_name	string	Required within parent	Represents the API name of the missing expected field. Maximum length: 255
expected_fields[].json_path	string	Required within parent	Represents the JSON path of the missing expected field. Maximum length: 500

Get Cadence records count — response body — cadences records count cadences records count item status error details id

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details containing the unique identifier of the resource associated with the error. Additional keys: not allowed
id	string	Required within parent	Represents the unique identifier of the resource. Maximum length: 255

Get Cadence records count — response body — cadences records count cadences records count item status error details object

Field	Type	Presence	Description and constraints
$	object	Root	Represents an empty error details object with no additional information. Additional keys: not allowed

Get Cadence records count — response body — cadences records count cadences records count item status error details param name

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details containing the parameter name associated with the error. Additional keys: not allowed
param_name	string	Required within parent	Represents the parameter name associated with the error detail. Maximum length: 255

Get Cadence records count — response body — cadences records count cadences records count item status error details permissions

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details when the request fails due to missing permissions. Additional keys: not allowed
permissions	array	Required within parent	Represents the list of required permissions that are missing. Maximum items: 25
permissions[]	string	Each item	Represents the name of a required permission. Maximum length: 255

Get Cadence records count — response body — cadences records count cadences records count item status error details resource path index

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details containing the resource path index where the validation error occurred. Additional keys: not allowed
resource_path_index	JSON	Required within parent
resource_path_index (anyOf 1)	integer	Alternative	Represents the index of the resource path where the validation error occurred. Format: int32
resource_path_index (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Cadence records count — response body — cadences_records_count / cadences_records_count / item / status error / details / param_name: ids

Field	Type	Presence	Description and constraints
$	object	Root	Represents error details containing the parameter name associated with the error. Additional keys: not allowed
param_name	string	Required within parent	Represents the parameter name associated with the error detail. Possible values: ids - The ids query parameter. Known values: ids Maximum length: 255

Get a Cadence — response body — cadences

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response containing the details of a specific Cadence retrieved by its identifier. Additional keys: not allowed
cadences	array	Optional	Represents the list of Cadences with their full details. Maximum items: 1
cadences[]	object	Each item	Represents the detailed configuration and metadata for a single Cadence. Additional keys: not allowed
cadences[].created_by	Model	Optional	Expand Get Cadence analytics — response body — cadences item created by
cadences[].created_time	string	Optional	Represents the creation date and time of the Cadence, in ISO 8601 format. Format: date-time
cadences[].custom_view	Model	Optional	Expand Get a Cadence — response body — cadences cadences item custom view
cadences[].description	string	Optional	Represents the description text of a Cadence. Maximum length: 500
cadences[].draft_cadence	object	Optional	Represents the draft version of the Cadence, if one exists. Additional keys: not allowed
cadences[].draft_cadence.id	string	Optional	Represents the unique identifier of a Cadence. Maximum length: 255
cadences[].draft_cadence.name	string	Optional	Represents the name of a Cadence. Maximum length: 100
cadences[].execution_details	JSON	Optional
cadences[].execution_details (anyOf 1)	object	Alternative	Represents the execution frequency and unenrollment configuration for the Cadence. Additional keys: not allowed
cadences[].execution_details (anyOf 1).execute_every	Model	Optional	Expand Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties execute every
cadences[].execution_details (anyOf 1).unenroll_properties	JSON	Optional
cadences[].execution_details (anyOf 1).unenroll_properties (anyOf 1)	array	Alternative	Represents the list of conditions under which records are automatically unenrolled from the Cadence. Maximum items: 50
cadences[].execution_details (anyOf 1).unenroll_properties (anyOf 1)[]	Model	Each item	Expand Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties unenroll properties null item
cadences[].execution_details (anyOf 1).unenroll_properties (anyOf 2)	null	Alternative	Represents the list of conditions under which records are automatically unenrolled from the Cadence. Maximum items: 50
cadences[].execution_details (anyOf 1).unenroll_properties (anyOf 2)[]	Model	Each item	Expand Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties unenroll properties null item
cadences[].execution_details (anyOf 2)	null	Alternative	Represents the execution frequency and unenrollment configuration for the Cadence. Additional keys: not allowed
cadences[].execution_details (anyOf 2).execute_every	Model	Optional	Expand Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties execute every
cadences[].execution_details (anyOf 2).unenroll_properties	JSON	Optional
cadences[].execution_details (anyOf 2).unenroll_properties (anyOf 1)	array	Alternative	Represents the list of conditions under which records are automatically unenrolled from the Cadence. Maximum items: 50
cadences[].execution_details (anyOf 2).unenroll_properties (anyOf 1)[]	Model	Each item	Expand Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties unenroll properties null item
cadences[].execution_details (anyOf 2).unenroll_properties (anyOf 2)	null	Alternative	Represents the list of conditions under which records are automatically unenrolled from the Cadence. Maximum items: 50
cadences[].execution_details (anyOf 2).unenroll_properties (anyOf 2)[]	Model	Each item	Expand Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties unenroll properties null item
cadences[].follow_ups	array	Optional	Represents the list of follow-up steps configured in the Cadence. Maximum items: 200
cadences[].follow_ups[]	object	Each item	Represents a single follow-up step in the Cadence. Additional keys: not allowed
cadences[].follow_ups[].action	object	Required within parent	Represents the action configured for the follow-up step. Additional keys: allowed
cadences[].follow_ups[].execute_after	object	Optional	Represents the wait period before this follow-up step executes. Additional keys: not allowed
cadences[].follow_ups[].execute_after.id	string	Optional	Represents the unique identifier for the execute-after configuration. Maximum length: 255
cadences[].follow_ups[].execute_after.period	string	Optional	Represents the numeric duration of the wait period. Maximum length: 255
cadences[].follow_ups[].execute_after.unit	JSON	Optional
cadences[].follow_ups[].execute_after.unit (anyOf 1)	integer	Alternative	Represents the time unit for the wait period. Format: int32
cadences[].follow_ups[].execute_after.unit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cadences[].follow_ups[].id	string	Required within parent	Represents the unique identifier of the follow-up step. Maximum length: 255
cadences[].follow_ups[].parent_follow_up	JSON	Required within parent
cadences[].follow_ups[].parent_follow_up (anyOf 1)	object	Alternative	Represents the parent follow-up step that this step branches from.
cadences[].follow_ups[].parent_follow_up (anyOf 1).id	string	Optional	Represents the unique identifier of the parent follow-up step. Maximum length: 255
cadences[].follow_ups[].parent_follow_up (anyOf 1).type	string	Optional	Represents the branch type of the parent follow-up connection. Maximum length: 255
cadences[].follow_ups[].parent_follow_up (anyOf 2)	null	Alternative	Represents the parent follow-up step that this step branches from.
cadences[].follow_ups[].parent_follow_up (anyOf 2).id	string	Optional	Represents the unique identifier of the parent follow-up step. Maximum length: 255
cadences[].follow_ups[].parent_follow_up (anyOf 2).type	string	Optional	Represents the branch type of the parent follow-up connection. Maximum length: 255
cadences[].follow_ups[].triggers	JSON	Optional
cadences[].follow_ups[].triggers (anyOf 1)	array	Alternative	Represents the list of trigger conditions for the follow-up step. Maximum items: 25
cadences[].follow_ups[].triggers (anyOf 1)[]	string	Each item	Represents a single trigger condition for the follow-up step. Maximum length: 255
cadences[].follow_ups[].triggers (anyOf 2)	null	Alternative	Represents the list of trigger conditions for the follow-up step. Maximum items: 25
cadences[].follow_ups[].triggers (anyOf 2)[]	string	Each item	Represents a single trigger condition for the follow-up step. Maximum length: 255
cadences[].id	string	Required within parent	Represents the unique identifier of a Cadence. Maximum length: 255
cadences[].modified_by	Model	Optional	Expand Get a Cadence — response body — cadences cadences item modified by
cadences[].modified_time	JSON	Optional
cadences[].modified_time (anyOf 1)	string	Alternative	Represents the date and time when the Cadence was last modified. Maximum length: 255
cadences[].modified_time (anyOf 2)	null	Alternative	Represents the date and time when the Cadence was last modified. Maximum length: 255
cadences[].module	Model	Required within parent	Expand Get Cadence analytics — response body — cadences item module
cadences[].name	string	Required within parent	Represents the name of a Cadence. Maximum length: 100
cadences[].parent_cadence	object	Optional	Represents the original Cadence from which this Cadence was cloned. Additional keys: not allowed
cadences[].parent_cadence.id	string	Optional	Represents the unique identifier of a Cadence. Maximum length: 255
cadences[].parent_cadence.name	string	Optional	Represents the name of a Cadence. Maximum length: 100
cadences[].status	string	Required within parent	Cadence lifecycle status. draft = not yet published; active = published and enrolling records; inactive = published but currently deactivated. Maximum length: 255
cadences[].summary	Model	Optional	Expand Get a Cadence — response body — cadences cadences item summary
cadences[].type	string	Required within parent	Represents the enrollment type of a Cadence, indicating how records are enrolled. Known values: custom_view, manual_enrollment Maximum length: 255

Referenced models: Get Cadence analytics — response body — cadences item created by, Get Cadence analytics — response body — cadences item module, Get a Cadence — response body — cadences cadences item custom view, Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties execute every, Get a Cadence — response body — cadences cadences item summary, Get a Cadence — response body — cadences cadences item modified by, Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties unenroll properties null item

Get a Cadence — response body — cadences cadences item custom view

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Represents the identifier and name of a Custom View. Additional keys: not allowed
$ (anyOf 1).id	string	Optional	Represents the unique identifier of the Custom View. Maximum length: 255
$ (anyOf 1).name	string	Optional	Represents the name of the Custom View. Maximum length: 255
$ (anyOf 2)	null	Alternative	Represents the identifier and name of a Custom View. Additional keys: not allowed
$ (anyOf 2).id	string	Optional	Represents the unique identifier of the Custom View. Maximum length: 255
$ (anyOf 2).name	string	Optional	Represents the name of the Custom View. Maximum length: 255

Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties execute every

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Represents the recurring execution interval for a Cadence, specifying the frequency period and numeric value. Additional keys: not allowed
$ (anyOf 1).period	string	Required within parent	Represents the frequency interval for recurring Cadence execution. Possible values: immediately - Execute immediately after each enrollment trigger. hours - Execute at the specified number of hours interval. days - Execute at the specified number of days interval. weeks - Execute at the specified number of weeks interval. Known values: immediately, hours, days, weeks
$ (anyOf 1).unit	JSON	Optional
$ (anyOf 1).unit (anyOf 1)	integer	Alternative	Represents the numeric value of the execution interval, expressed in the specified period unit. Format: int32 Maximum: 99 Minimum: 1
$ (anyOf 1).unit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)	null	Alternative	Represents the recurring execution interval for a Cadence, specifying the frequency period and numeric value. Additional keys: not allowed
$ (anyOf 2).period	string	Required within parent	Represents the frequency interval for recurring Cadence execution. Possible values: immediately - Execute immediately after each enrollment trigger. hours - Execute at the specified number of hours interval. days - Execute at the specified number of days interval. weeks - Execute at the specified number of weeks interval. Known values: immediately, hours, days, weeks
$ (anyOf 2).unit	JSON	Optional
$ (anyOf 2).unit (anyOf 1)	integer	Alternative	Represents the numeric value of the execution interval, expressed in the specified period unit. Format: int32 Maximum: 99 Minimum: 1
$ (anyOf 2).unit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a Cadence — response body — cadences cadences item execution details execute every, unenroll properties unenroll properties null item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single unenrollment condition. Additional keys: not allowed
details	JSON	Optional
details (anyOf 1)	object	Alternative	Represents additional details for the unenrollment condition.
details (anyOf 2)	null	Alternative	Represents additional details for the unenrollment condition.
id	string	Optional	Represents the unique identifier of the unenrollment condition. Maximum length: 255
type	string	Optional	Represents the type of unenrollment condition. Maximum length: 255

Get a Cadence — response body — cadences cadences item modified by

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Represents the identifier and name of the user who last modified the record. Additional keys: not allowed
$ (anyOf 1).id	string	Optional	Represents the unique identifier of the user who last modified the record. Maximum length: 255
$ (anyOf 1).name	string	Optional	Represents the full name of the user who last modified the record. Maximum length: 255
$ (anyOf 2)	null	Alternative	Represents the identifier and name of the user who last modified the record. Additional keys: not allowed
$ (anyOf 2).id	string	Optional	Represents the unique identifier of the user who last modified the record. Maximum length: 255
$ (anyOf 2).name	string	Optional	Represents the full name of the user who last modified the record. Maximum length: 255

Get a Cadence — response body — cadences cadences item summary

Field	Type	Presence	Description and constraints
$	object	Root	Represents a summary of follow-up action counts in a Cadence, broken down by action type. Additional keys: not allowed
call_follow_up_count	JSON	Optional
call_follow_up_count (anyOf 1)	integer	Alternative	Represents the number of scheduled call follow-up actions in the Cadence. Format: int32
call_follow_up_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
email_follow_up_count	JSON	Optional
email_follow_up_count (anyOf 1)	integer	Alternative	Represents the number of email notification follow-up actions in the Cadence. Format: int32
email_follow_up_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
task_follow_up_count	JSON	Optional
task_follow_up_count (anyOf 1)	integer	Alternative	Represents the number of task follow-up actions in the Cadence. Format: int32
task_follow_up_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
whatsapp_follow_up_count	JSON	Optional
whatsapp_follow_up_count (anyOf 1)	integer	Alternative	Represents the number of WhatsApp message follow-up actions in the Cadence. Format: int32
whatsapp_follow_up_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List Cadences — response body — cadences, info cadences item execution details automatic unenroll, end date, execute every, type, unenroll properties unenroll properties

Field	Type	Presence	Description and constraints
$	object	Root	Represents the automatic unenrollment configuration applied when records are removed from the Cadence. Additional keys: not allowed
end_date	string	Optional	Represents the date on which the automatic unenrollment of records from the Cadence takes effect. Maximum length: 50
type	JSON	Optional
type (anyOf 1)	string	Alternative	Represents the type of automatic unenrollment applied to the Cadence. Maximum length: 255
type (anyOf 2)	null	Alternative	Represents the type of automatic unenrollment applied to the Cadence. Maximum length: 255

Publish a Cadence — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for publishing one or more Cadences. Additional keys: not allowed
cadences	array	Required within parent	Represents the list of Cadences to publish. Maximum items: 1
cadences[]	object or null	Each item	Represents the publish configuration for a single Cadence. Additional keys: not allowed
cadences[].process_existing_records	boolean	Optional	Represents whether existing records should be enrolled in the Cadence upon publication.