Zoho: Workflow rules schemas (part 2)

← Workflow rules operations · All schemas

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value 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	JSON	Optional
apply_restriction (anyOf 1)	boolean	Alternative	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
apply_restriction (anyOf 2)	null	Alternative	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 Automation Task — workflow Tasks get Task By Id — response body — tasks 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 List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type add meeting 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: Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details module, Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type add meeting details layout

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type tasks

Field	Type	Presence	Description and constraints
$	object	Root	Represents an associate action that creates a task based on a pre-configured task template when the workflow rule condition is triggered. Additional keys: not allowed
_delete	null	Optional	Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
details	object	Optional	Represents the read-only details of the associated task action. Returned in GET responses and not required in POST or PUT requests. Additional keys: not allowed
details.module	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module The module this action applies to.
id	string	Required within parent	Represents the unique ID of the task action. Required to associate a pre-configured task with the workflow rule. Maximum length: 20
name	string	Optional	Represents the display name of the TaskAssociate action. Returned in GET responses and derived from the referenced action configuration. Maximum length: 500
related_details	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type tasks related details Configures a followup task that is automatically created after the original task, based on a status condition and time delay. Null when no followup is configured.
type	string	Required within parent	Represents the action type discriminator that identifies this as a TaskAssociate action within the workflow rule. The value is fixed for this action type and must be supported by the target module and trigger event. Must equal: tasks

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type tasks related details

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type tasks related details

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the optional related configuration details for task actions, specifying whether and how a followup task should be created.
$ (anyOf 1)	object	Alternative	Represents the followup task configuration that defines the status condition and delay for automatically creating a followup task. Additional keys: not allowed
$ (anyOf 1).followup_details	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type tasks related details followup details followup details
$ (anyOf 2)	null	Alternative	Represents a null value indicating no followup task is configured for this task action.

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type tasks related details followup details followup details

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type tasks related details followup details followup details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the followup task configuration, including the trigger condition and delay settings. Additional keys: not allowed
condition	string	Optional	Represents the task status condition that triggers the followup task, such as **Completed** or **Not Started**. Maximum length: 255
period	string	Optional	Represents the time period label for the delay before creating the followup task, such as **days**, **hours**, or **minutes**. Maximum length: 50
unit	JSON	Optional
unit (anyOf 1)	integer	Alternative	Represents the numeric time value for the delay before creating the followup task. Format: int32
unit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value — Associate Actions Nested Schema

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents an associate action that references a pre-configured action entity by its unique ID. Use the appropriate entity API to retrieve valid IDs. discriminator: {"propertyName": "type"}
$ (anyOf 1)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type email notifications
$ (anyOf 2)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type field updates
$ (anyOf 3)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type tasks
$ (anyOf 4)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / instant_actions / actions / item / value / type: webhooks, functions, sms, whatsapp

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type email notifications, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type field updates, List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / instant_actions / actions / item / value / type: webhooks, functions, sms, whatsapp, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type tasks

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value — Non Associate Actions Nested Schema

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents an inline action configuration that is defined directly within the workflow rule condition, rather than referencing a pre-created action entity by ID. discriminator: {"propertyName": "type"}
$ (anyOf 1)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type assign owner
$ (anyOf 2)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type create record
$ (anyOf 3)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type create connected record
$ (anyOf 4)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type add meeting
$ (anyOf 5)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type schedule call
$ (anyOf 6)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type add tags
$ (anyOf 7)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type remove tags
$ (anyOf 8)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type convert
$ (anyOf 9)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value delete, details, id, name, type — Chat Notification Action Schema
$ (anyOf 10)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type circuits
$ (anyOf 11)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type flow
$ (anyOf 12)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value delete, details, id, name, type — Social Action Schema
$ (anyOf 13)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type create record email

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type circuits, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type add meeting, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type add tags, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type assign owner, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value delete, details, id, name, type — Chat Notification Action Schema, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type convert, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type create connected record, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type create record, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type create record email, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type remove tags, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type schedule call, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value delete, details, id, name, type — Social Action Schema, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type flow

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	array	Alternative	Represents the container for scheduled actions that execute after a configured delay from the time the workflow rule condition is triggered. Maximum items: 5
$ (anyOf 1)[]	JSON	Each item
$ (anyOf 1)[] (anyOf 1)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id — shared_outputscheduledactionsnestedschema_0d33c969f93c
$ (anyOf 1)[] (anyOf 2)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id — shared_outputscheduledactionsnestedschema_e59c1d2ff5cb
$ (anyOf 2)	null	Alternative	Represents the container for scheduled actions that execute after a configured delay from the time the workflow rule condition is triggered. Maximum items: 5
$ (anyOf 2)[]	JSON	Each item
$ (anyOf 2)[] (anyOf 1)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id — shared_outputscheduledactionsnestedschema_0d33c969f93c
$ (anyOf 2)[] (anyOf 2)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id — shared_outputscheduledactionsnestedschema_e59c1d2ff5cb

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id — shared_outputscheduledactionsnestedschema_0d33c969f93c, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id — shared_outputscheduledactionsnestedschema_e59c1d2ff5cb

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id execute after

Field	Type	Presence	Description and constraints
$	object	Root	Defines the delay before the scheduled actions execute. Required. Cannot be an empty object. Additional keys: not allowed
period	string	Required within parent	Represents the type of time interval. Required. Must be one of the allowed period values (invalid_schedule_actions_period if invalid). business_hours and business_days are only available when org business hours are configured. The API returns available periods from getWorkflowConfigurations. Known values: minutes, hours, days, weeks, months, years, business_hours, business_days
unit	JSON	Required within parent
unit (anyOf 1)	integer	Alternative	Represents the numeric delay value. Required. Allowed ranges per period (unit_not_allowed_for_period if out of range): minutes: 5-180 (2-180 if 1-min repetition feature is enabled), hours: 0-99, days: 0-2000, weeks: 0-100, months: 0-24, years: 0-10, business_hours: 0-99, business_days: 0-2000. All values must be non-negative (no pre-event offsets for scheduled actions). Format: int32
unit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id — shared_outputscheduledactionsnestedschema_0d33c969f93c

Field	Type	Presence	Description and constraints
$	object	Root	Specify when the scheduled actions should be executed Additional keys: not allowed
actions	array	Required within parent	Represents the array of action objects for this scheduled group. Uses the same associate and non-associate action structure as instant actions, but only action types that support scheduled execution are allowed. Per-type limits apply independently to instant and scheduled actions. Maximum items: 50
actions[]	JSON	Each item
actions[] (anyOf 1)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value — Non Associate Actions Nested Schema
actions[] (anyOf 2)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value — Associate Actions Nested Schema
execute_after	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id execute after
id	string	Optional	Represents unique Id of the scheduled action Maximum length: 20

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value — Associate Actions Nested Schema, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value — Non Associate Actions Nested Schema, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id execute after

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id — shared_outputscheduledactionsnestedschema_e59c1d2ff5cb

Field	Type	Presence	Description and constraints
$	null	Root	Specify when the scheduled actions should be executed Additional keys: not allowed
actions	array	Required within parent	Represents the array of action objects for this scheduled group. Uses the same associate and non-associate action structure as instant actions, but only action types that support scheduled execution are allowed. Per-type limits apply independently to instant and scheduled actions. Maximum items: 50
actions[]	JSON	Each item
actions[] (anyOf 1)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value — Non Associate Actions Nested Schema
actions[] (anyOf 2)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value — Associate Actions Nested Schema
execute_after	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id execute after
id	string	Optional	Represents unique Id of the scheduled action Maximum length: 20

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value — Associate Actions Nested Schema, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value — Non Associate Actions Nested Schema, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions null item actions, execute after, id execute after

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item created by

Field	Type	Presence	Description and constraints
$	object	Root	Represents the identity details of the CRM user who created or last modified the workflow rule. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the CRM user. Format: string
name	string	Optional	Represents the name of the CRM user who created or last modified the workflow rule. Format: string

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the trigger configuration that defines when the workflow rule fires, including the trigger type and its associated details. discriminator: {"mapping": {"activate": "#/components/schemas/ExecuteWhenT1Simple", "anyaction": "#/components/schemas/ExecuteWhenT1Simple", "cancel": "#/components/schemas/ExecuteWhenT1Simple", "create": "#/components/schemas/ExecuteWhenT1Simple", "create_or_edit": "#/components/schemas/ExecuteWhenT1Simple", "date_or_datetime": "#/components/schemas/ExecuteWhenT4DateBased", "deactivate": "#/components/schemas/ExecuteWhenT1Simple", "delete": "#/components/schemas/ExecuteWhenT1Simple", "edit": "#/components/schemas/ExecuteWhenT1Simple", "email_received": "#/components/schemas/ExecuteWhenT1Simple", "email_received_notreplied": "#/components/schemas/ExecuteWhenT5TimeOffset", "email_received_opened_notreplied": "#/components/schemas/ExecuteWhenT5TimeOffset", "fb_comment_on_page": "#/components/schemas/ExecuteWhenT1Simple", "fb_like_on_post": "#/components/schemas/ExecuteWhenT1Simple", "fb_post_on_page": "#/components/schemas/ExecuteWhenT1Simple", "fb_send_message": "#/components/schemas/ExecuteWhenT1Simple", "field_update": "#/components/schemas/ExecuteWhenT2FieldUpdate", "incoming_call_createedit": "#/components/schemas/ExecuteWhenT1Simple", "incoming_call_edit": "#/components/schemas/ExecuteWhenT1Simple", "incoming_call_field_update": "#/components/schemas/ExecuteWhenT2FieldUpdate", "incoming_call_ring": "#/components/schemas/ExecuteWhenT1Simple", "incoming_call_section_update": "#/components/schemas/ExecuteWhenT3SectionUpdate", "incoming_call_start": "#/components/schemas/ExecuteWhenT1Simple", "mail_sent": "#/components/schemas/ExecuteWhenT1Simple", "mail_sent_bounced": "#/components/schemas/ExecuteWhenT1Simple", "mail_sent_clicked": "#/components/schemas/ExecuteWhenT1Simple", "mail_sent_notopened": "#/components/schemas/ExecuteWhenT5TimeOffset", "mail_sent_notreplied": "#/components/schemas/ExecuteWhenT5TimeOffset", "mail_sent_opened": "#/components/schemas/ExecuteWhenT1Simple", "mail_sent_opened_notreplied": "#/components/schemas/ExecuteWhenT5TimeOffset", "mail_sent_replied": "#/components/schemas/ExecuteWhenT1Simple", "mail_sent_replied_within": "#/components/schemas/ExecuteWhenT7EmailRepliedWithin", "marked_as_complete": "#/components/schemas/ExecuteWhenT1Simple", "missed_call": "#/components/schemas/ExecuteWhenT1Simple", "outgoing_call_createedit": "#/components/schemas/ExecuteWhenT1Simple", "outgoing_call_edit": "#/components/schemas/ExecuteWhenT1Simple", "outgoing_call_field_update": "#/components/schemas/ExecuteWhenT2FieldUpdate", "outgoing_call_ring": "#/components/schemas/ExecuteWhenT1Simple", "outgoing_call_section_update": "#/components/schemas/ExecuteWhenT3SectionUpdate", "outgoing_call_start": "#/components/schemas/ExecuteWhenT1Simple", "overdue": "#/components/schemas/ExecuteWhenT5TimeOffset", "reassign": "#/components/schemas/ExecuteWhenT1Simple", "recommendation_rebuy": "#/components/schemas/ExecuteWhenT5TimeOffset", "reschedule": "#/components/schemas/ExecuteWhenT1Simple", "rollup_summary_update": "#/components/schemas/ExecuteWhenT2FieldUpdate", "scheduled_call_createedit": "#/components/schemas/ExecuteWhenT1Simple", "scheduled_call_edit": "#/components/schemas/ExecuteWhenT1Simple", "scheduled_call_field_update": "#/components/schemas/ExecuteWhenT2FieldUpdate", "scheduled_call_section_update": "#/components/schemas/ExecuteWhenT3SectionUpdate", "score_decrease": "#/components/schemas/ExecuteWhenT6ScoreUpdate", "score_increase": "#/components/schemas/ExecuteWhenT6ScoreUpdate", "score_update": "#/components/schemas/ExecuteWhenT6ScoreUpdate", "section_update": "#/components/schemas/ExecuteWhenT3SectionUpdate", "stage_automation_field_update": "#/components/schemas/ExecuteWhenT2FieldUpdate", "tw_comment_on_tweet": "#/components/schemas/ExecuteWhenT1Simple", "tw_mention_on": "#/components/schemas/ExecuteWhenT1Simple", "tw_retweet_on_tweet": "#/components/schemas/ExecuteWhenT1Simple", "tw_send_message": "#/components/schemas/ExecuteWhenT1Simple", "voc_incoming_signal": "#/components/schemas/ExecuteWhenT1Simple", "zia_scoring_rule": "#/components/schemas/ExecuteWhenT6ScoreUpdate"}, "propertyName": "type"}
$ (anyOf 1)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type — Execute When T1 Simple
$ (anyOf 2)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type — Execute When T2 Field Update
$ (anyOf 3)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type — Execute When T3 Section Update
$ (anyOf 4)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: date or datetime
$ (anyOf 5)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type — Execute When T5 Time Offset
$ (anyOf 6)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: score increase, score decrease, score update, zia scoring rule
$ (anyOf 7)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: mail sent replied within

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type — Execute When T1 Simple, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type — Execute When T2 Field Update, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type — Execute When T3 Section Update, List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: date or datetime, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type — Execute When T5 Time Offset, List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: score increase, score decrease, score update, zia scoring rule, List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: mail sent replied within

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type details — shared_details_819c866740fd

Field	Type	Presence	Description and constraints
$	object	Root	Represents the optional trigger configuration details, including **repeat** (Boolean) and **trigger_module** (object) for cross-module triggers. Additional keys: not allowed
repeat	boolean	Optional	Indicates whether the rule fires every time the trigger condition is met. When false, the rule fires only on the first occurrence.
trigger_module	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module The module that actually triggers the rule. Defaults to the rule's top-level module if omitted. Must be explicitly set when the trigger targets a different module, such as a rule on Leads triggered by a note creation event, which requires the trigger module to reference the Notes module. To discover module API names and identifiers, retrieve the available modules from the system.

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type details — shared_details_be3cf6ec2c47

Field	Type	Presence	Description and constraints
$	object	Root	Represents the section update trigger details, including the layout section IDs to monitor. Additional keys: not allowed
repeat	boolean	Optional	Indicates whether the rule fires every time a section update condition is met. When false, the rule fires only on the first occurrence.
section_ids	array	Required within parent	Represents the array of layout section IDs to monitor for updates. Each ID must correspond to a valid section ID for the target module. Maximum items: 10 Minimum items: 1
section_ids[]	string	Each item	Represents the unique ID of a layout section to monitor. Format: int64
trigger_module	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module Optional. The module that actually triggers the rule. Defaults to the rule's top-level module if omitted. Must be explicitly set when the trigger targets a different module - e.g., a rule on Leads triggered by 'note created' requires trigger_module = {api_name: 'Notes', id: '...'}. Use `getModules` to discover module api_name and id values.

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type — Execute When T1 Simple

Field	Type	Presence	Description and constraints
$	object	Root	Represents a simple trigger type (T1) that fires on record creation, editing, deletion, or when specific CRM events occur, with optional repeat and cross-module support. Additional keys: not allowed
details	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type details — shared_details_819c866740fd
type	string	Required within parent	Represents the trigger API name that activates the workflow rule. Supported values vary by module; use the getWorkflowConfigurations endpoint to retrieve supported triggers for the target module. Known values: create, edit, create_or_edit, delete, cancel, reschedule, reassign, anyaction, deactivate, activate, marked_as_complete, incoming_call_ring, incoming_call_start, incoming_call_createedit, incoming_call_edit, outgoing_call_ring, outgoing_call_start, outgoing_call_edit, outgoing_call_createedit, missed_call, scheduled_call_createedit, scheduled_call_edit, email_received, mail_sent, mail_sent_clicked, mail_sent_replied, mail_sent_opened, mail_sent_bounced, fb_post_on_page, fb_comment_on_page, fb_like_on_post, fb_send_message, tw_mention_on, tw_retweet_on_tweet, tw_comment_on_tweet, tw_send_message, voc_incoming_signal

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type details — shared_details_819c866740fd

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type — Execute When T2 Field Update

Field	Type	Presence	Description and constraints
$	object	Root	Represents a field update trigger type that fires when a specified field value on a record changes according to defined criteria. Additional keys: not allowed
details	object	Required within parent	Represents the field update trigger details, including the criteria that define which field value change activates the rule. Additional keys: not allowed
details.criteria	JSON	Required within parent	Represents the field value change criteria that activate the trigger. Defines which field is monitored and what change condition fires the rule.
details.criteria (anyOf 1)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / details, type / details / criteria / type: merge field, pre defined, value, field
details.criteria (anyOf 2)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / details, type / details / criteria / group_operator: AND, OR
details.match_all	boolean	Optional	Controls the logic applied across criteria groups. Possible values: true - All criteria groups must match (AND logic). false - Any one criteria group is sufficient (OR logic).
details.repeat	boolean	Optional	Indicates whether the rule fires every time the field update condition is met. When false, the rule fires only on the first occurrence.
details.trigger_module	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module The module that actually triggers the rule. Defaults to the rule's top-level module if omitted. Must be explicitly set when the trigger targets a different module - e.g., a rule on Leads triggered by 'note created' requires trigger_module = {api_name: 'Notes', id: '...'}. Use `getModules` to discover module api_name and id values.
type	string	Required within parent	Represents the trigger type for field update rules. Availability varies by the target module. Known values: field_update, incoming_call_field_update, outgoing_call_field_update, scheduled_call_field_update, stage_automation_field_update, rollup_summary_update

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module, List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / details, type / details / criteria / group_operator: AND, OR, List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / details, type / details / criteria / type: merge field, pre defined, value, field

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type — Execute When T3 Section Update

Field	Type	Presence	Description and constraints
$	object	Root	Represents the trigger type for section update rules. Availability varies by the target module Additional keys: not allowed
details	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type details — shared_details_be3cf6ec2c47
type	string	Required within parent	Represents the trigger type for section update rules. Use getWorkflowConfigurations to verify the trigger is available for the target module. Known values: section_update, incoming_call_section_update, outgoing_call_section_update, scheduled_call_section_update

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type details — shared_details_be3cf6ec2c47

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type — Execute When T5 Time Offset

Field	Type	Presence	Description and constraints
$	object	Root	Represents the trigger type for time-offset rules. Availability varies by the target module. Additional keys: not allowed
details	object	Required within parent	Represents the time offset trigger details, including the time unit and magnitude for the offset. Additional keys: not allowed
details.field	object	Optional	Represents the field reference returned in GET responses for time-offset triggers, including the trigger field details. Additional keys: not allowed
details.field.id	string	Optional	Represents the field identifier for the time-offset trigger. Returns **-1** when the field is system-determined. Maximum length: 20
details.period	string	Required within parent	Represents the time unit for the offset. Possible values: days - Offset in days. hours - Offset in hours. Known values: days, hours
details.trigger_module	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module The module that actually triggers the rule. Defaults to the rule's top-level module if omitted. Must be explicitly set when the trigger targets a different module - e.g., a rule on Leads triggered by 'note created' requires trigger_module = {api_name: 'Notes', id: '...'}. Use `getModules` to discover module api_name and id values.
details.unit	JSON	Required within parent
details.unit (anyOf 1)	integer	Alternative	Represents the time offset magnitude. Always a positive integer for time-offset triggers, such as 1 for one day or 3 for three hours. Format: int32
details.unit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	Represents the trigger type for time-offset rules. Use getWorkflowConfigurations to verify the trigger is available for the target module. Known values: overdue, email_received_notreplied, email_received_opened_notreplied, mail_sent_opened_notreplied, mail_sent_notreplied, mail_sent_notopened, recommendation_rebuy

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item lock

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lock configuration of a workflow rule, including the lock state and the identity of the user who applied the lock. Additional keys: not allowed
locked_by	JSON	Optional	Represents the details of the CRM user who locked the workflow rule.
locked_by (anyOf 1)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item lock locked by id, name
locked_by (anyOf 2)	null	Alternative	Represents a null value indicating the workflow rule is not currently locked by any user.
message	JSON	Optional
message (anyOf 1)	string	Alternative	Represents the note or label indicating the reason or context for locking the rule. Format: string
message (anyOf 2)	null	Alternative	Represents the note or label indicating the reason or context for locking the rule. Format: string
status	boolean	Optional	Indicates whether the workflow rule is locked. Possible values: true - The rule is locked. false - The rule is not locked.

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item lock locked by id, name

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item lock locked by id, name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the identity of the CRM user who locked the workflow rule, including their display name and unique ID. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the CRM user who locked the workflow rule. Format: string
name	string	Optional	Represents the name of the CRM user who locked the workflow rule. Format: string

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item modified time

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Represents a time offset specification combining a period label and a numeric magnitude, used in time-based workflow trigger configurations. Format: date-time Maximum length: 255
$ (anyOf 2)	null	Alternative	Represents a time offset specification combining a period label and a numeric magnitude, used in time-based workflow trigger configurations. Format: date-time Maximum length: 255

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM module or field reference using its API name and unique numeric ID. Minimum fields: 1 Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the module or field, such as **Leads**, **Contacts**, or a custom field API name. Maximum length: 100
id	string	Required within parent	Represents the unique numeric ID of the module or field. Maximum length: 20

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item status

Field	Type	Presence	Description and constraints
$	object	Root	Represents the activation state of a workflow rule, indicating whether the rule is currently active. Additional keys: not allowed
active	boolean	Optional	Indicates whether the workflow rule is currently active. Possible values: true - The workflow rule is active and executes its configured actions when trigger conditions are met. false - The workflow rule is inactive and does not execute, even when trigger conditions are met.

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / criteria_details / criteria / group_operator: AND, OR, and, or

Field	Type	Presence	Description and constraints
$	object	Root	Represents a grouped filter criterion containing multiple filter conditions evaluated with a logical operator. Supports recursive nesting for complex filtering logic. Additional keys: not allowed
group	array	Required within parent	Contains an array of filter conditions grouped together and evaluated with the specified logical operator. Maximum items: 25 Minimum items: 2
group[]	JSON	Each item
group[] (anyOf 1)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item criteria details criteria value
group[] (anyOf 2)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / criteria_details / criteria / group_operator: AND, OR, and, or
group_operator	string	Required within parent	Represents the logical operator applied between the filter conditions in the group. Possible values: AND - All conditions in the group must be satisfied. OR - At least one condition in the group must be satisfied. and - Equivalent to AND; all conditions in the group must be satisfied. or - Equivalent to OR; at least one condition in the group must be satisfied. Known values: AND, OR, and, or

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / criteria_details / criteria / group_operator: AND, OR, and, or, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item criteria details criteria value

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / criteria_details / criteria / value / comparator: between, not between, type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents a filter criterion for the between and not_between comparators. The value must be an array of exactly two elements — [lower_bound, upper_bound]. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for date or datetime fields, and SimpleFilterCriterionValueNumber for integer, currency, or double fields. Resolve the data_type from the field's FieldSchema. For formula fields, use formula.return_type as the effective data_type; for rollup_summary fields, use rollup_summary.return_type. Additional keys: not allowed
comparator	string	Required within parent	Represents the range comparison operator applied to the criterion, indicating whether the field value falls within or outside the specified bounds. Possible values: between - Matches records where the field value falls within the specified range. not_between - Matches records where the field value falls outside the specified range. Known values: between, not_between
field	JSON	Required within parent	Represents the target field definition to which the range filter criterion is applied, conforming to the base field structure.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the range filter criterion. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value
value	array	Required within parent	Contains the two boundary values — [lower_bound, upper_bound] — against which the field is evaluated for the between or not_between comparator. Maximum items: 2 Minimum items: 2
value[]	JSON	Each item
value[] (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value[] (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / criteria_details / criteria / value / comparator: in, not in, type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents a filter criterion for the in and not_in comparators. The value must be an array of primitive values. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for text-based types, and SimpleFilterCriterionValueNumber for integer, currency, or double fields. Additional keys: not allowed
comparator	string	Required within parent	Represents the set membership comparison operator applied to the criterion. Possible values: in - Matches records where the field value is in the specified set of values. not_in - Matches records where the field value is not in the specified set of values. Known values: in, not_in
field	JSON	Required within parent	Represents the target field definition to which the set filter criterion is applied, conforming to the base field structure.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the set filter criterion. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value
value	array	Required within parent	Contains an array of primitive filter values used in the set comparison. Maximum items: 500 Minimum items: 1
value[]	JSON	Each item
value[] (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value[] (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / criteria_details / criteria / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents a filter criterion for the include_all, include_any, exclude_all, and exclude_any comparators. Applicable only when the field's data_type is multiuserlookup or multiselectlookup. The value must be an array of SimpleFilterCriterionValueObjectRequest lookup objects. Additional keys: not allowed
comparator	string	Required within parent	Represents the multi-select lookup comparison operator applied to the criterion. Applicable only when the field's data_type is multiuserlookup or multiselectlookup. Possible values: include_all - Matches records that include all specified lookup values. include_any - Matches records that include at least one of the specified lookup values. exclude_all - Matches records that exclude all specified lookup values. exclude_any - Matches records that exclude at least one of the specified lookup values. Known values: include_all, include_any, exclude_all, exclude_any
field	JSON	Required within parent	Represents the target field definition to which the multi-select lookup filter criterion is applied. The field must have a data_type of multiuserlookup or multiselectlookup.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the multi-select lookup filter criterion. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value
value	array	Required within parent	Contains an array of lookup object references used in the multi-select comparison. Maximum items: 5 Minimum items: 1
value[]	Model	Each item	Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / criteria_details / criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents a filter criterion for the less_than, less_equal, greater_than, and greater_equal comparators. The value must be a scalar; arrays and objects are not supported. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for date or datetime fields, and SimpleFilterCriterionValueNumber for integer, currency, or double fields. Additional keys: not allowed
comparator	string	Required within parent	Represents the ordering comparison operator applied to the criterion. Possible values: less_than - Matches records where the field value is less than the specified filter value. less_equal - Matches records where the field value is less than or equal to the specified filter value. greater_than - Matches records where the field value is greater than the specified filter value. greater_equal - Matches records where the field value is greater than or equal to the specified filter value. Known values: less_than, less_equal, greater_than, greater_equal
field	JSON	Required within parent	Represents the target field definition to which the ordering filter criterion is applied, conforming to the base field structure.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the ordering filter criterion. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value
value	JSON	Required within parent	Represents the scalar filter value used in the ordering comparator. Arrays and objects are not supported for ordering comparators.
value (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
value (anyOf 3)	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / criteria_details / criteria / value / comparator: like, not like, starts with, ends with, contains, not contains, type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents a filter criterion for the like, not_like, starts_with, ends_with, contains, and not_contains comparators. The value must be a string scalar or array; use SimpleFilterCriterionValueString for text-based field types. Object and Boolean values are not supported. Resolve the data_type from the field's FieldSchema. Additional keys: not allowed
comparator	string	Required within parent	Represents the text comparison operator applied to the criterion. Possible values: like - Matches records where the field value contains the specified pattern. not_like - Matches records where the field value does not contain the specified pattern. starts_with - Matches records where the field value begins with the specified string. ends_with - Matches records where the field value ends with the specified string. contains - Matches records where the field value contains the specified string. not_contains - Matches records where the field value does not contain the specified string. Known values: like, not_like, starts_with, ends_with, contains, not_contains
field	JSON	Required within parent	Represents the target field definition to which the text filter criterion is applied, conforming to the base field structure.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the text filter criterion. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value
value	JSON	Required within parent	Represents the string filter value used in the text comparator. Accepts a scalar string or an array of string values.
value (anyOf 1)	array	Alternative	Contains an array of primitive string values for the text filter comparator. Maximum items: 500 Minimum items: 1
value (anyOf 1)[]	JSON	Each item
value (anyOf 1)[] (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 2)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / criteria_details / criteria / value / value / comparator: equal, type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents a filter criterion for the equal comparator. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime fields; SimpleFilterCriterionValueNumber for integer, currency, or double fields; SimpleFilterCriterionValueBoolean for Boolean fields; SimpleFilterCriterionValueObjectRequest for lookup, ownerlookup, or userlookup fields; and SimpleFilterCriterionValueObjectPredefined for predefined user or role object placeholders. Accepts scalar or array values. Resolve the data_type from the field's FieldSchema. Additional keys: not allowed
comparator	string	Required within parent	Represents the equal comparison operator applied to the criterion. Possible values: equal - Matches records where the field value equals the specified filter value. Known values: equal
field	JSON	Required within parent	Represents the target field definition to which the equal filter criterion is applied, conforming to the base field structure.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the equal filter criterion. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value
value	JSON	Required within parent	Represents the filter value used in the equal comparator. Accepts a scalar or an array of values, depending on the field's data_type.
value (anyOf 1)	array	Alternative	Contains an array of filter values for the equal comparator. Maximum items: 500 Minimum items: 1
value (anyOf 1)[]	JSON	Each item
value (anyOf 1)[] (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 1)[] (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
value (anyOf 1)[] (anyOf 3)	JSON	Alternative
value (anyOf 1)[] (anyOf 3) (anyOf 1)	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
value (anyOf 1)[] (anyOf 3) (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value
value (anyOf 2)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 3)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
value (anyOf 4)	boolean	Alternative	Represents a Boolean filter criterion value. Applicable only when the field has a Boolean data type (checkbox field).
value (anyOf 5)	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
value (anyOf 6)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value
value (anyOf 7)	string	Alternative	Represents a predefined placeholder value applicable to any field data_type with the equal comparator. Possible values: ${EMPTY} - Matches records where the field has no value. ${NOTEMPTY} - Matches records where the field has any non-empty value. Known values: ${EMPTY}, ${NOTEMPTY}
value (anyOf 8)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value string
value (anyOf 9)	string	Alternative	Represents a predefined N-period range placeholder value applicable only when the field's data_type is date or datetime, with the equal comparator. Follows the pattern ${NEXT_N_<PERIOD>:<n>} or ${LAST_N_<PERIOD>:<n>}, where PERIOD is DAYS, WEEKS, MONTHS, or YEARS and n is a positive integer. The current period is always excluded from the range. Maximum length: 255 Pattern: ^\$\{(LAST_N_|NEXT_N_)(DAYS|WEEKS|MONTHS|YEARS):([0-9]+)\}$
value (anyOf 10)	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value string, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value, Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / criteria_details / criteria / value / value / comparator: not equal, type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents a filter criterion for the not_equal comparator. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime fields; SimpleFilterCriterionValueNumber for integer, currency, or double fields; SimpleFilterCriterionValueBoolean for Boolean fields; SimpleFilterCriterionValueObjectRequest for lookup, ownerlookup, or userlookup fields; and SimpleFilterCriterionValueObjectPredefined for predefined user or role object placeholders. Additional keys: not allowed
comparator	string	Required within parent	Represents the not-equal comparison operator applied to the criterion. Possible values: not_equal - Matches records where the field value does not equal the specified filter value. Known values: not_equal
field	JSON	Required within parent	Represents the target field definition to which the not-equal filter criterion is applied, conforming to the base field structure.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents the field reference constraint that requires the api_name property to be present for the not-equal filter criterion. Additional keys: allowed
type	string	Optional	Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Known values: merge_field, pre_defined, value, field Default: value
value	JSON	Required within parent	Represents the filter value used in the not_equal comparator. Accepts a scalar or an array of values, depending on the field's data_type.
value (anyOf 1)	array	Alternative	Contains an array of filter values for the not_equal comparator. Maximum items: 500 Minimum items: 1
value (anyOf 1)[]	JSON	Each item
value (anyOf 1)[] (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 1)[] (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
value (anyOf 1)[] (anyOf 3)	JSON	Alternative
value (anyOf 1)[] (anyOf 3) (anyOf 1)	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
value (anyOf 1)[] (anyOf 3) (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value
value (anyOf 2)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 3)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
value (anyOf 4)	boolean	Alternative	Represents a Boolean filter criterion value. Applicable only when the field has a Boolean data type (checkbox field).
value (anyOf 5)	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
value (anyOf 6)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value
value (anyOf 7)	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / value / comparator: equal, type: merge field, value, pre defined, field value value, Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / instant_actions / actions / item / value / type assign_owner / details / assign_to / item / type: user, role, group, assignment rule, profile

Field	Type	Presence	Description and constraints
$	object	Root	PURPOSE: assign_to entry for resource-based ownership. MANDATORY: type (user|role|group|assignment_rule|profile), resource ({id, name}). For type=profile: associated_to must be 'team_profile'. For round-robin: use multiple entries of type=user. Additional keys: not allowed
allow_agent_user	boolean	Optional	Whether to allow assignment to an agent user or not. When true, the record can be assigned to an agent user also. When false, agent users are excluded from assignment. Applicable only for types: role, group, profile, merge_field, criteria. Not supported for types user and assignment_rule. Default: false
associated_to	JSON	Optional
associated_to (anyOf 1)	string	Alternative	Association context for profile-based assignment. Must be "team_profile" when type=profile. Not applicable for other assignment types; if provided for a non-profile type, the API returns DEPENDENT_MISMATCH. Known values: team_profile
associated_to (anyOf 2)	null	Alternative	Association context for profile-based assignment. Must be "team_profile" when type=profile. Not applicable for other assignment types; if provided for a non-profile type, the API returns DEPENDENT_MISMATCH. Known values: team_profile
details	null	Optional	Always null for resource-based assignments. Present in GET responses for schema consistency with other assign_to types.
resource	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / instant_actions / actions / item / value / type assign_owner / details / assign_to / item / type: user, role, group, assignment rule, profile resource Identifies the target user, role, group, assignment rule, or profile by ID and/or name. At least one of id or name must be provided; if both are given and they do not match, the API returns AMBIGUITY_DURING_PROCESSING.
type	string	Required within parent	Assignment method. Determines what kind of entity receives ownership. Values: "user" - assign to a specific CRM user (GET /settings/users), for round-robin include multiple assign_to entries of type=user; "role" - assign to a user holding the specified role (GET /settings/roles), system picks an eligible user at execution time; "group" - assign to a member of the specified user group (GET /settings/user_groups); "assignment_rule" - assign using a pre-configured assignment rule (GET /settings/automation/assignment_rules), the rule's criteria and round-robin logic determine the final owner; "profile" - assign to a user matching the specified profile (GET /settings/profiles), must include associated_to=team_profile. Known values: user, role, group, assignment_rule, profile

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / instant_actions / actions / item / value / type assign_owner / details / assign_to / item / type: user, role, group, assignment rule, profile resource

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / instant_actions / actions / item / value / type assign_owner / details / assign_to / item / type: user, role, group, assignment rule, profile resource

Field	Type	Presence	Description and constraints
$	object	Root	PURPOSE: Resource reference for assign_to entry. MANDATORY: id (string). OPTIONAL: name, type. Obtain from GET /settings/users (user), /settings/roles (role), /settings/user_groups (group), /settings/automation/assignment_rules (assignment_rule), /settings/profiles (profile). If both id and name given, must match (AMBIGUITY_DURING_PROCESSING). Additional keys: not allowed
id	string	Required within parent	Unique identifier of the target entity. Obtain from the corresponding API: GET /settings/users (for user), GET /settings/roles (for role), GET /settings/user_groups (for group), GET /settings/automation/assignment_rules (for assignment_rule), or GET /settings/profiles (for profile). Maximum length: 255
name	string	Optional	Display name of the target entity. Optional in POST/PUT requests (server resolves from id); always present in GET responses. Maximum length: 255
type	string	Optional	Type of the target entity. Present in GET responses; not required in POST/PUT requests. Known values: user, role, group, assignment_rule, profile

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / conditions / item / instant_actions / actions / item / value / type: webhooks, functions, sms, whatsapp

Field	Type	Presence	Description and constraints
$	object	Root	Represents an associate action that references a pre-configured action entity by its unique ID, applicable to action types such as webhooks, functions, and notifications. Additional keys: not allowed
_delete	null	Optional	Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
details	object	Optional	Represents the read-only details of the associated action entity. Returned in GET responses and not required in POST or PUT requests. Additional keys: not allowed
details.module	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module The module this action applies to.
id	string	Required within parent	Represents the unique ID of the pre-configured action entity. Required to associate an existing action with the workflow rule. Maximum length: 20
name	string	Optional	Represents the display name of the SimpleAssociate action. Returned in GET responses and derived from the referenced action configuration. Maximum length: 500
type	string	Required within parent	Represents the type of associate action. Possible values: webhooks - HTTP callback to an external URL. functions - Custom function execution. email_notifications - Automated email notification. tasks - Task creation action. Known values: webhooks, functions, sms, whatsapp

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / details, type / details / criteria / group_operator: AND, OR

Field	Type	Presence	Description and constraints
$	object	Root	Represents a grouped filter criterion containing multiple simple filter conditions evaluated together using a logical operator such as AND or OR. Additional keys: not allowed
group	array	Required within parent	Represents the array of filter conditions to be evaluated together using the specified logical operator. Maximum items: 25 Minimum items: 2
group[]	JSON	Each item
group[] (anyOf 1)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / details, type / details / criteria / type: merge field, pre defined, value, field
group[] (anyOf 2)	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / details, type / details / criteria / group_operator: AND, OR
group_operator	string	Required within parent	Represents the logical operator applied between the filter conditions in the group. Known values: AND, OR

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / details, type / details / criteria / group_operator: AND, OR, List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / details, type / details / criteria / type: merge field, pre defined, value, field

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / details, type / details / criteria / type: merge field, pre defined, value, field

Field	Type	Presence	Description and constraints
$	object	Root	Represents a simple filter criterion for workflow rule queries, specifying the field API name, comparator, and value to match. Additional keys: not allowed
comparator	string	Required within parent	Represents the comparison operator applied to the filter criterion. **${ANYVALUE}** is a special value supported only in field update triggers; it matches any change to the monitored field value. Known values: equal, not_equal, like, not_like, starts_with, ends_with, contains, not_contains, greater_than, greater_equal, less_equal, less_than, in, not_in, between, ${ANYVALUE}
field	JSON	Required within parent	Represents the field to which the filter criterion is applied.
field (allOf 1)	Model	All variants apply	Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
field (allOf 2)	object	All variants apply	Represents additional field reference constraints for the filter criterion, requiring the `api_name` property to identify the target field. Additional keys: allowed
type	string	Optional	Indicates whether the criterion value is a direct value or a system variable placeholder. Known values: merge_field, pre_defined, value, field Default: value
value	JSON	Required within parent
value (anyOf 1)	string	Alternative	Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255
value (anyOf 2)	Model	Alternative	Expand Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value
value (anyOf 3)	boolean	Alternative	Represents a Boolean filter criterion value. Applicable only when the field has a Boolean data type (checkbox field).
value (anyOf 4)	Model	Alternative	Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item

Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Get territory by ID — response body — territories / territories / item / deal_rule_criteria / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value value, Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: date or datetime

Field	Type	Presence	Description and constraints
$	object	Root	Represents the date or datetime field to monitor for triggering the rule. Must reference an existing date or datetime field on the module. Additional keys: not allowed
details	object	Required within parent	Represents the date-based trigger details, including the target date field, time offset, and recurrence configuration. Additional keys: not allowed
details.execute_at	string	Optional	Represents the exact time of day at which to fire the trigger, in 24-hour HH:mm format. Applicable only to datetime fields. Format: time
details.field	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: date or datetime details field
details.period	string	Required within parent	Represents the time unit for the offset relative to the monitored date field. For example, **days**, **weeks**, or **months**. Known values: minutes, hours, days, weeks, months, years, b_hours, b_days
details.recur_cycle	string	Optional	Represents the recurrence frequency for the date-based trigger. Possible values: once - Fires once. monthly - Fires monthly on the same date. yearly - Fires yearly on the same date. Known values: once, monthly, yearly
details.repeat	boolean	Optional	Indicates whether the trigger fires repeatedly. When true, the trigger fires on each recurrence as configured.
details.trigger_module	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module Specifies the module that triggers the workflow rule. If omitted, it defaults to the rule's top-level module. Specify this when the trigger targets a different module. For example, a workflow rule on Leads triggered when a note is created requires 'trigger_module': {"api_name": "Notes", 'id': '...'}. Use 'getModules' to retrieve the module API name and ID.
details.unit	JSON	Required within parent
details.unit (anyOf 1)	integer	Alternative	Represents the offset magnitude relative to the monitored date field value. Negative values indicate before the date; positive values indicate after. Format: int32
details.unit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	Represents the trigger type for date or datetime-based rules, which fire relative to a date field value on the record. Known values: date_or_datetime

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module, List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: date or datetime details field

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: date or datetime details field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the date or datetime field to monitor for triggering the rule. Use the getFields endpoint to discover available date and datetime fields. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the date or datetime field, such as **Created_Time**, **Modified_Time**, or a custom field API name. Maximum length: 255
id	string	Optional	Represents the unique ID of the date or datetime field. Maximum length: 20

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: mail sent replied within

Field	Type	Presence	Description and constraints
$	object	Root	Represents an email-reply-window trigger type (T7) that fires when a sent email receives a reply within a configured time window. Additional keys: not allowed
details	object	Required within parent	Represents the email-reply-window trigger details, including the time unit and magnitude for the reply window. Additional keys: not allowed
details.period	string	Required within parent	Represents the time unit for the reply window. Possible values: days - Window measured in days. hours - Window measured in hours. Known values: days, hours
details.trigger_module	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module The module that actually triggers the rule. Defaults to the rule's top-level module if omitted. Must be explicitly set when the trigger targets a different module - e.g., a rule on Leads triggered by 'note created' requires trigger_module = {api_name: 'Notes', id: '...'}. Use `getModules` to discover module api_name and id values.
details.unit	JSON	Required within parent
details.unit (anyOf 1)	integer	Alternative	Represents the reply window magnitude, such as 3 for a window of three days or three hours. Format: int32
details.unit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	Represents the trigger type for email-reply-window rules. Requires a dedicated email module workflow rule. Known values: mail_sent_replied_within

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: score increase, score decrease, score update, zia scoring rule

Field	Type	Presence	Description and constraints
$	object	Root	Represents a score update trigger type (T6) that fires when a record score changes due to configured scoring rules. Additional keys: not allowed
details	object	Required within parent	Represents the score update trigger details, including the Scoring Rule scope and the applicable scoring rules. Additional keys: not allowed
details.repeat	boolean	Optional	Indicates whether the rule fires every time the score condition is met. When false, the rule fires only on the first occurrence.
details.rules	array	Optional	Represents the array of Scoring Rule references to monitor. Required when **type** is set to **Selective_Rules**. Maximum items: 50 Minimum items: 1
details.rules[]	Model	Each item	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: score increase, score decrease, score update, zia scoring rule details rules item
details.trigger_module	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module The module that actually triggers the rule. Defaults to the rule's top-level module if omitted. Must be explicitly set when the trigger targets a different module, such as a rule on Leads triggered by a note creation event, which requires the trigger module to reference the Notes module. To discover module API names and identifiers, retrieve the available modules from the system.
details.type	string	Required within parent	Represents the trigger type for scoring rules. Supports score increase and score decrease trigger events. Known values: All_Rules, Selective_Rules
type	string	Required within parent	Represents the trigger type for scoring rules. Supports score increase and score decrease trigger events. Known values: score_increase, score_decrease, score_update, zia_scoring_rule

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module, List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: score increase, score decrease, score update, zia scoring rule details rules item

List Workflow Rules in your Zoho CRM Organization — response body — workflow_rules / item / execute_when / type: score increase, score decrease, score update, zia scoring rule details rules item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single Scoring Rule reference. Must include the Scoring Rule ID for POST and PUT requests. The name field is read-only and returned in GET responses. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the Scoring Rule. Maximum length: 20
name	string	Optional	Represents the display name of the Scoring Rule. This field is read-only and returned in GET responses. Maximum length: 255 Read only: true

Retrieve Action Usage for a Workflow Rule — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body containing detailed execution usage metrics for one or more workflow rules within a queried date range. Additional keys: not allowed
workflow_rules	array	Required within parent	Represents the array of workflow rule usage objects. Maximum items: 10
workflow_rules[]	object	Each item	Represents the usage report for a single workflow rule, including execution metrics at the condition level. Additional keys: not allowed
workflow_rules[].conditions	array	Required within parent	Represents the array of condition objects with usage metrics for the workflow rule. Maximum items: 10
workflow_rules[].conditions[]	JSON	Each item
workflow_rules[].conditions[] (anyOf 1)	Model	Alternative	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count — Workflow Condition Usage Summary Schema
workflow_rules[].conditions[] (anyOf 2)	Model	Alternative	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count — Workflow Condition Usage With Tagged Instant Actions Schema
workflow_rules[].id	string	Required within parent	Represents the unique ID of the workflow rule. Maximum length: 20
workflow_rules[].name	string	Required within parent	Represents the name of the workflow rule. Maximum length: 255
workflow_rules[].reset_time	JSON	Required within parent
workflow_rules[].reset_time (anyOf 1)	string	Alternative	Represents the ISO 8601 timestamp when the usage counters were last reset. Maximum length: 255
workflow_rules[].reset_time (anyOf 2)	null	Alternative	Represents the ISO 8601 timestamp when the usage counters were last reset. Maximum length: 255
workflow_rules[].trigger_count	JSON	Required within parent
workflow_rules[].trigger_count (anyOf 1)	integer	Alternative	Represents the number of times this workflow rule was triggered within the queried date range. Format: int32
workflow_rules[].trigger_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count — Workflow Condition Usage Summary Schema, Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count — Workflow Condition Usage With Tagged Instant Actions Schema

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions actions item

Field	Type	Presence	Description and constraints
$	object	Root	Represents usage metrics for a single tagged workflow action, including its identifier, tag ID, action type, and success and failure counts. Additional keys: not allowed
associated_time	string	Required within parent	Represents the ISO 8601 timestamp indicating when this tagged action was last associated with or modified on a workflow rule. Maximum length: 255
failure_count	JSON	Required within parent
failure_count (anyOf 1)	integer	Alternative	Represents the total number of failed executions recorded for this tagged action within the queried date range. Format: int32
failure_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	Represents the unique ID of the TaggedActionUsageMetrics within the workflow rule. Maximum length: 20
name	string	Required within parent	Represents the display name of the workflow rule or its associated tagged action. Maximum length: 255
success_count	JSON	Required within parent
success_count (anyOf 1)	integer	Alternative	Represents the total number of successful executions recorded for this tagged action within the queried date range. Format: int32
success_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tag_id	string	Required within parent	Represents the unique ID of the tag associated with this action. Maximum length: 20
type	string	Required within parent	Represents the category of tagged workflow action executed by the rule. Maximum length: 255

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions actions item associated time, failure count, id, name, success count, type

Field	Type	Presence	Description and constraints
$	object	Root	Represents usage metrics for a single workflow action, including its identifier, display name, action type, execution success and failure counts within a queried date range, and the timestamp of its last association. Additional keys: not allowed
associated_time	string	Required within parent	Represents the ISO 8601 timestamp indicating when this action was last associated with or modified on a workflow rule. Maximum length: 255
failure_count	JSON	Required within parent
failure_count (anyOf 1)	integer	Alternative	Represents the total number of failed executions recorded for this action within the queried date range. Format: int32
failure_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	Represents the unique ID of the workflow action. Maximum length: 20
name	string	Required within parent	Represents the display name of the workflow rule or its associated action as configured in Zoho CRM. Maximum length: 255
success_count	JSON	Required within parent
success_count (anyOf 1)	integer	Alternative	Represents the total number of successful executions recorded for this action within the queried date range. Format: int32
success_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	Represents the category of workflow action executed by the rule. Maximum length: 255

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions — Instant Actions Usage List Schema

Field	Type	Presence	Description and constraints
$	object	Root	Represents a container for the list of instant action usage detail objects associated with a workflow rule condition. Additional keys: not allowed
actions	array	Required within parent	Represents the array of action usage detail objects for the instant actions configured in this condition. Maximum items: 5
actions[]	JSON	Each item
actions[] (anyOf 1)	Model	Alternative	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item actions item
actions[] (anyOf 2)	Model	Alternative	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions actions item associated time, failure count, id, name, success count, type

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions actions item associated time, failure count, id, name, success count, type, Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item actions item

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions — Instant Actions Usage With Tags Schema

Field	Type	Presence	Description and constraints
$	object	Root	Represents a container for instant action usage details that include tag-based metrics, grouped within a workflow rule condition. Additional keys: not allowed
actions	array	Required within parent	Represents the array of action usage detail objects, including those associated with tags, for the instant actions configured in this condition. Maximum items: 5
actions[]	Model	Each item	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions actions item

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions actions item

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions

Field	Type	Presence	Description and constraints
$	array	Root	Represents the list of scheduled action groups for a workflow rule, each group containing the actions and their execution usage metrics. Maximum items: 5
$[]	object	Each item	Represents a scheduled action group configured for the workflow rule, including its execute-after delay and the list of actions within the group. Additional keys: not allowed
$[].actions	array	Required within parent	Represents the list of action execution records within this scheduled action group. Maximum items: 5
$[].actions[]	object	Each item	Represents the usage details for a single action within the scheduled action group. Additional keys: not allowed
$[].actions[].associated_time	string	Required within parent	Represents the ISO 8601 timestamp when this action was last executed or associated. Format: date-time
$[].actions[].failure_count	JSON	Required within parent
$[].actions[].failure_count (anyOf 1)	integer	Alternative	Represents the number of failed executions for this action within the date range. Format: int32
$[].actions[].failure_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].actions[].id	string	Required within parent	Represents the unique ID of the executed action. Format: string
$[].actions[].name	string	Required within parent	Represents the name of the executed action. Format: string
$[].actions[].queue_count	JSON	Required within parent
$[].actions[].queue_count (anyOf 1)	integer	Alternative	Represents the number of execution instances currently in queue for this action. Format: int32
$[].actions[].queue_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].actions[].related_details	object	Optional	Represents additional information related to the action execution, such as email notification performance metrics. Additional keys: allowed
$[].actions[].success_count	JSON	Required within parent
$[].actions[].success_count (anyOf 1)	integer	Alternative	Represents the number of successful executions for this action within the date range. Format: int32
$[].actions[].success_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].actions[].type	string	Required within parent	Represents the type of action executed, such as **email_notifications**. Format: string
$[].id	string	Required within parent	Represents unique identifier for the scheduled action. Format: string

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single scheduled action group within a workflow rule, containing the group ID and usage metrics for each action in the group. Additional keys: not allowed
actions	array	Required within parent	Represents the array of action usage detail objects within this scheduled action group. Maximum items: 5
actions[]	Model	Each item	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item actions item
id	string	Required within parent	Represents the unique ID of the ScheduledActionsUsageGroup within the workflow rule. Maximum length: 255

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item actions item

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item actions item

Field	Type	Presence	Description and constraints
$	object	Root	Represents usage metrics for a single queued workflow action, including success, failure, and queue counts within a queried date range. Additional keys: not allowed
associated_time	string	Required within parent	Represents the ISO 8601 timestamp indicating when this queued action was last associated with or modified on a workflow rule. Maximum length: 255
failure_count	JSON	Required within parent
failure_count (anyOf 1)	integer	Alternative	Represents the total number of failed executions recorded for this queued action within the queried date range. Format: int32
failure_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	Represents the unique ID of the QueuedActionUsageMetrics within the workflow rule. Maximum length: 20
name	string	Required within parent	Represents the display name of the workflow rule or its associated queued action as configured in Zoho CRM. Maximum length: 255
queue_count	JSON	Required within parent
queue_count (anyOf 1)	integer	Alternative	Represents the number of executions currently queued and pending for this action. Format: int32
queue_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
related_details	Model	Required within parent	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item actions item related details
success_count	JSON	Required within parent
success_count (anyOf 1)	integer	Alternative	Represents the total number of successful executions recorded for this queued action within the queried date range. Format: int32
success_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	Represents the category of queued workflow action. Possible values include **email_notifications**, **field_updates**, **tasks**, **webhooks**, **functions**, **assign_owner**, **add_tags**, **remove_tags**, **create_record**, **add_meeting**, **schedule_call**, and **convert**. Maximum length: 255

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item actions item related details

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item actions item related details

Field	Type	Presence	Description and constraints
$	object	Root	Represents email engagement metrics for an email notification action, including sent, delivered, opened, clicked, bounced, and unsent counts. Additional keys: not allowed
bounced	JSON	Required within parent
bounced (anyOf 1)	integer	Alternative	Represents number of emails that bounced back. Format: int32
bounced (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
bulk_mail	boolean	Required within parent	Represents number of bulk email messages sent.
clicked	JSON	Required within parent
clicked (anyOf 1)	integer	Alternative	Represents number of emails where recipients clicked a link. Format: int32
clicked (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
delivered	JSON	Required within parent
delivered (anyOf 1)	integer	Alternative	Represents number of emails successfully delivered. Format: int32
delivered (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
opened	JSON	Required within parent
opened (anyOf 1)	integer	Alternative	Represents number of emails opened by recipients. Format: int32
opened (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sent	JSON	Required within parent
sent (anyOf 1)	integer	Alternative	Represents total number of emails sent. Format: int32
sent (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sent_percentage	JSON	Required within parent
sent_percentage (anyOf 1)	integer	Alternative	Represents percentage of emails successfully sent out of total attempted. Format: int32
sent_percentage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unopened	JSON	Required within parent
unopened (anyOf 1)	integer	Alternative	Represents number of emails not opened by recipients. Format: int32
unopened (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unsent	JSON	Required within parent
unsent (anyOf 1)	integer	Alternative	Represents number of emails that failed to send. Format: int32
unsent (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count — Workflow Condition Usage Summary Schema

Field	Type	Presence	Description and constraints
$	object	Root	Represents the execution usage summary for a single workflow rule condition, including total execution count and breakdowns for instant and scheduled action groups. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the WorkflowConditionUsageSummary within the workflow rule. Maximum length: 20
instant_actions	Model	Required within parent	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions — Instant Actions Usage List Schema
scheduled_actions	array	Required within parent	Represents the array of scheduled action groups configured for this condition. Maximum items: 5
scheduled_actions[]	Model	Each item	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item
usage_count	JSON	Required within parent
usage_count (anyOf 1)	integer	Alternative	Represents the total number of times the actions in this condition were executed. Format: int32
usage_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions — Instant Actions Usage List Schema, Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions item

Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count — Workflow Condition Usage With Tagged Instant Actions Schema

Field	Type	Presence	Description and constraints
$	object	Root	Represents the usage summary for a workflow rule condition where instant actions include tag-based metrics, along with scheduled action group data. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the WorkflowConditionUsageWithTaggedInstantActions within the workflow rule. Maximum length: 20
instant_actions	Model	Required within parent	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions — Instant Actions Usage With Tags Schema
scheduled_actions	Model	Required within parent	Expand Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions
usage_count	JSON	Required within parent
usage_count (anyOf 1)	integer	Alternative	Represents the total number of times the actions in this condition were executed. Format: int32
usage_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count instant actions — Instant Actions Usage With Tags Schema, Retrieve Action Usage for a Workflow Rule — response body — workflow rules item conditions item id, instant actions, scheduled actions, usage count scheduled actions

Retrieve Workflow Rule by ID — response body — workflow rules

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for a single workflow rule retrieval, containing a single-element array with the full rule details. Additional keys: not allowed
workflow_rules	array	Required within parent	Represents the array containing the single workflow rule retrieved. Maximum items: 10
workflow_rules[]	Model	Each item	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item

Update Workflow Rule Execution Order for Module — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body for reordering workflow rules, containing the new position assignments for each rule. Additional keys: not allowed
reorder	object	Required within parent	Represents the reorder payload containing the list of workflow rules and their updated execution order. Additional keys: not allowed
reorder.workflow_rules	array	Optional	Represents the array of workflow rule objects for which you want to update the execution order. Maximum items: 10
reorder.workflow_rules[]	object	Each item	Represents a single workflow rule entry in the reorder request, specifying the rule ID and its new module-specific sequence number. Additional keys: not allowed
reorder.workflow_rules[].id	string	Required within parent	Specify the ID of the workflow rule for which you want to update the execution order. Maximum length: 20
reorder.workflow_rules[].module_specific_sequence	integer	Required within parent	Specify the new execution order for this workflow rule within the module. The index must start from one. Format: int32

Update Workflow Rule Execution Order for Module — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response returned after reordering workflow rules. Additional keys: not allowed
reorder	array	Optional	Represents the array of workflow rule objects with their updated execution order. Maximum items: 125
reorder[]	Model	Each item	Expand Update Workflow Rule Execution Order for Module — response body — reorder item

Referenced models: Update Workflow Rule Execution Order for Module — response body — reorder item

Update Workflow Rule Execution Order for Module — response body — reorder item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single item in a multi-status response array, including a response code, status indicator, message, and optionally the resource details. Additional keys: not allowed
code	string	Optional	Represents the API response code indicating the operation result, such as **SUCCESS** or **INVALID_DATA**. Maximum length: 255
details	Model	Optional	Expand Update Workflow Rule Execution Order for Module — response body — reorder item details
message	string	Optional	Represents the message describing the operation result or error. Known values: workflow created, workflow updated, workflow deleted, WorkFlow Rule deleted successfully, rules reordered successfully, Workflow cloned successfully
status	string	Optional	Represents the response status indicator, such as **success** or **error**. Maximum length: 7

Referenced models: Update Workflow Rule Execution Order for Module — response body — reorder item details

Update Workflow Rule Execution Order for Module — response body — reorder item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details object within a success response, containing the unique ID of the created or updated resource. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the SuccessResponseDetails within the workflow rule. Maximum length: 255

Update Workflow Rule by ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body wrapper for updating an existing workflow rule. Contains a single-element array with the updated rule configuration. Additional keys: not allowed
workflow_rules	array	Required within parent	The request body must contain a **workflow_rules** array with one object. Maximum items: 1
workflow_rules[]	Model	Each item	Expand Update Workflow Rule by ID — request body — body workflow rules item

Referenced models: Update Workflow Rule by ID — request body — body workflow rules item

Update Workflow Rule by ID — request body — body / workflow_rules / item / conditions / item / instant_actions / actions / item / value / type assign_owner / details / assign_to / item / associated_to: team profile, None, type: user, role, group, assignment rule, profile

Field	Type	Presence	Description and constraints
$	object	Root	PURPOSE: assign_to entry for resource-based ownership. MANDATORY: type (user|role|group|assignment_rule|profile), resource ({id, name}). For type=profile: associated_to must be 'team_profile'. For round-robin: use multiple entries of type=user. Additional keys: not allowed
allow_agent_user	boolean	Optional	Whether to allow assignment to an agent user or not. When true, the record can be assigned to an agent user also. When false, agent users are excluded from assignment. Applicable only for types: role, group, profile, merge_field, criteria. Not supported for types user and assignment_rule. Default: false
associated_to	string or null	Optional	Association context for profile-based assignment. Must be "team_profile" when type=profile. Not applicable for other assignment types; if provided for a non-profile type, the API returns DEPENDENT_MISMATCH. One of: team_profile, null
details	null	Optional	Always null for resource-based assignments. Present in GET responses for schema consistency with other assign_to types.
resource	Model	Required within parent	Expand Update Workflow Rule by ID — request body — body / workflow_rules / item / conditions / item / instant_actions / actions / item / value / type assign_owner / details / assign_to / item / associated_to: team profile, None, type: user, role, group, assignment rule, profile resource Identifies the target user, role, group, assignment rule, or profile by ID and/or name. At least one of id or name must be provided; if both are given and they do not match, the API returns AMBIGUITY_DURING_PROCESSING.
type	string	Required within parent	Assignment method. Determines what kind of entity receives ownership. Values: "user" - assign to a specific CRM user (GET /settings/users), for round-robin include multiple assign_to entries of type=user; "role" - assign to a user holding the specified role (GET /settings/roles), system picks an eligible user at execution time; "group" - assign to a member of the specified user group (GET /settings/user_groups); "assignment_rule" - assign using a pre-configured assignment rule (GET /settings/automation/assignment_rules), the rule's criteria and round-robin logic determine the final owner; "profile" - assign to a user matching the specified profile (GET /settings/profiles), must include associated_to=team_profile. One of: user, role, group, assignment_rule, profile

Referenced models: Update Workflow Rule by ID — request body — body / workflow_rules / item / conditions / item / instant_actions / actions / item / value / type assign_owner / details / assign_to / item / associated_to: team profile, None, type: user, role, group, assignment rule, profile resource

Update Workflow Rule by ID — request body — body / workflow_rules / item / conditions / item / instant_actions / actions / item / value / type assign_owner / details / assign_to / item / associated_to: team profile, None, type: user, role, group, assignment rule, profile resource

Field	Type	Presence	Description and constraints
$	object	Root	PURPOSE: Resource reference for assign_to entry. MANDATORY: id (string). OPTIONAL: name, type. Obtain from GET /settings/users (user), /settings/roles (role), /settings/user_groups (group), /settings/automation/assignment_rules (assignment_rule), /settings/profiles (profile). If both id and name given, must match (AMBIGUITY_DURING_PROCESSING). Additional keys: not allowed
id	string	Required within parent	Unique identifier of the target entity. Obtain from the corresponding API: GET /settings/users (for user), GET /settings/roles (for role), GET /settings/user_groups (for group), GET /settings/automation/assignment_rules (for assignment_rule), or GET /settings/profiles (for profile). Maximum length: 255
name	string	Optional	Display name of the target entity. Optional in POST/PUT requests (server resolves from id); always present in GET responses. Maximum length: 255
type	string	Optional	Type of the target entity. Present in GET responses; not required in POST/PUT requests. One of: user, role, group, assignment_rule, profile

Update Workflow Rule by ID — request body — body / workflow_rules / item / conditions / item / instant_actions / actions / item / value / type: webhooks, functions, sms, whatsapp

Field	Type	Presence	Description and constraints
$	object	Root	Represents an associate action that references a pre-configured action entity by its unique ID, applicable to action types such as webhooks, functions, and notifications. Additional keys: not allowed
_delete	null	Optional	Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
details	object	Optional	Represents the read-only details of the associated action entity. Returned in GET responses and not required in POST or PUT requests. Additional keys: not allowed
details.module	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module The module this action applies to.
id	string	Required within parent	Represents the unique ID of the pre-configured action entity. Required to associate an existing action with the workflow rule. Maximum length: 20
name	string	Optional	Represents the display name of the SimpleAssociate action. Returned in GET responses and derived from the referenced action configuration. Maximum length: 500
type	string	Required within parent	Represents the type of associate action. Possible values: webhooks - HTTP callback to an external URL. functions - Custom function execution. email_notifications - Automated email notification. tasks - Task creation action. One of: webhooks, functions, sms, whatsapp

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module