Zoho: Workflow rules schemas (part 1)

61 Zoho schemas with complete fields and constraints.

← Workflow rules operations · All schemas

Create a workflow rule for a module — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the request body wrapper for creating a new workflow rule. Contains a single-element array with the workflow rule configuration. Additional keys: not allowed
`workflow_rules`	array	Required within parent	Represents the array containing the workflow rule object to create. The array must contain exactly one object per request. Maximum items: 1
`workflow_rules[]`	Model	Each item	Expand Create a workflow rule for a module — request body — body workflow rules item

Referenced models: Create a workflow rule for a module — request body — body workflow rules item

Create a workflow rule for a module — request body — body workflow rules item

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the configuration object for a new workflow rule, including required fields such as name, target module, and trigger configuration. Additional keys: not allowed
`conditions`	array	Required within parent	Specify the conditions that define the branching logic of the workflow rule. Each condition evaluates records against criteria and executes its own set of actions. At least one condition is required. Maximum items: 10
`conditions[]`	Model	Each item	Expand Update Workflow Rule by ID — request body — body workflow rules item conditions item
`description`	string or null	Optional	Specify an optional description for the workflow rule. Set to null to clear an existing description. Maximum length: 1000
`execute_when`	Model	Required within parent	Expand Update Workflow Rule by ID — request body — body workflow rules item execute when Specifies when the workflow rule is triggered. This is a required JSON object with "type" and "details" properties. For example: {"type": "create_or_edit", "details": {"trigger_module": {"api_name": "Leads", "id": "..."}, "repeat": false}}. Passing a string instead of a JSON object, such as "create_or_edit", returns an "INVALID_DATA" error. The "details.trigger_module" must match the module associated with the workflow rule. Use "getWorkflowConfigurations" to retrieve the available triggers and their supported actions.
`lock`	object	Optional	Specify the lock configuration to prevent other users from editing the rule. Only administrators can lock or unlock rules. Additional keys: not allowed
`lock.message`	string	Optional	Specify the reason or context for locking the rule. Valid only when lock.status is set to true. Format: string
`lock.status`	boolean	Optional	Specify whether to lock the rule. Possible values: true - Locks the rule to prevent editing. false - Unlocks the rule.
`module`	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module The module to which the workflow rule applies. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module IDs. Required. Must be a workflow-supported module. If both id and api_name are provided, they must match. Use `getWorkflowConfigurations` to discover supported modules. Cannot be changed after creation.
`name`	string	Required within parent	Specify the workflow rule name. Required. Cannot exceed 100 characters. Special characters are not allowed. Maximum length: 100

Referenced models: Update Workflow Rule by ID — request body — body workflow rules item conditions item, Update Workflow Rule by ID — request body — body workflow rules item execute when, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module

Delete One or More Workflow Rules — response body — Wrapped error response with workflow_rules / workflow_rules / item / status: error

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the error response returned when a required parameter such as the module API name or field path is missing from the request. Additional keys: not allowed
`code`	string	Required within parent	Represents the error code that identifies the specific error condition. Known values: REQUIRED_PARAM_MISSING, INVALID_DATA, NOT_ALLOWED, INVALID_MODULE, INVALID_REQUEST, INVALID_REQUEST_METHOD, AUTHENTICATION_FAILURE, PATTERN_NOT_MATCHED, JSON_PARSE_ERROR
`details`	object	Required within parent	Represents the error details containing additional context about the failed request. Additional keys: not allowed
`details.api_name`	string	Optional	Represents the API name of the field or parameter that caused the validation error. Maximum length: 255
`details.expected_data_type`	string	Optional	Represents the expected_data_type value from the error detail object. Maximum length: 255
`details.id`	string	Optional	Represents the ID value from the error detail object. Maximum length: 20
`details.maximum_length`	JSON	Optional
`details.maximum_length (anyOf 1)`	integer	Alternative	Represents the maximum_length value from the error detail object. Format: int32
`details.maximum_length (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`details.param_name`	string	Optional	Represents the param_name value from the error detail object. Known values: ids, module, executed_from, executed_till, execute_on, sort_order, sort_by
`message`	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
`status`	string	Required within parent	Represents the response status for the error, typically error. Known values: error

Get Active and Total Workflow Rule Counts by Module — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents an alternate response model containing the workflow rule counts aggregated by CRM module. Additional keys: not allowed
`module_specific_count`	array	Required within parent	Represents action counts broken down by CRM module. Maximum items: 500
`module_specific_count[]`	Model	Each item	Expand Get Active and Total Workflow Rule Counts by Module — response body — module specific count item

Referenced models: Get Active and Total Workflow Rule Counts by Module — response body — module specific count item

Get Active and Total Workflow Rule Counts by Module — response body — module specific count item

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the workflow rule count details for a specific CRM module, including the number of active rules and total rules configured. Additional keys: not allowed
`active_rules_configured`	JSON	Required within parent
`active_rules_configured (anyOf 1)`	integer	Alternative	Represents number of currently active workflow rules configured. Format: int32
`active_rules_configured (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`module`	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module
`total_rules_configured`	JSON	Required within parent
`total_rules_configured (anyOf 1)`	integer	Alternative	Represents total number of workflow rules configured (active + inactive). Format: int32
`total_rules_configured (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

Get Workflow Rule Action Counts — response body — workflow rules

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the response body containing the action count breakdown for one or more workflow rules, grouped by condition. Additional keys: not allowed
`workflow_rules`	array	Required within parent	Represents the array of workflow rule objects with their action count details. Maximum items: 10
`workflow_rules[]`	Model	Each item	Expand Get Workflow Rule Action Counts — response body — workflow rules workflow rules item

Referenced models: Get Workflow Rule Action Counts — response body — workflow rules workflow rules item

Get Workflow Rule Action Counts — response body — workflow rules workflow rules item

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the action count breakdown for a single workflow rule, encapsulating the rule ID and its associated condition-level action count groups. Additional keys: not allowed
`conditions`	array	Required within parent	Represents array of condition objects containing criteria and actions for this rule. Maximum items: 10
`conditions[]`	Model	Each item	Expand Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item
`id`	string	Required within parent	Represents the unique ID of the WorkflowRuleActionCountGroup within the workflow rule. Maximum length: 20

Referenced models: Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item

Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the action count summary for a single workflow rule condition, including the condition ID, sequence number, and counts for instant and scheduled actions. Additional keys: not allowed
`id`	string	Required within parent	Represents the unique ID of the WorkflowConditionActionCountSummary within the workflow rule. Maximum length: 20
`instant_actions`	JSON	Required within parent
`instant_actions (anyOf 1)`	Model	Alternative	Expand Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item instant actions actions count
`instant_actions (anyOf 2)`	null	Alternative	Represents a null value indicating no instant actions are configured for this condition.
`scheduled_actions`	JSON	Required within parent
`scheduled_actions (anyOf 1)`	array	Alternative	Represents the array of scheduled action groups configured for this condition. Maximum items: 5
`scheduled_actions (anyOf 1)[]`	Model	Each item	Expand Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item instant actions actions count
`scheduled_actions (anyOf 2)`	null	Alternative	Represents the array of scheduled action groups configured for this condition. Maximum items: 5
`scheduled_actions (anyOf 2)[]`	Model	Each item	Expand Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item instant actions actions count
`sequence_number`	JSON	Required within parent
`sequence_number (anyOf 1)`	integer	Alternative	Represents the execution order of this condition within the workflow rule, starting from one. Format: int32
`sequence_number (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item instant actions actions count

Get Workflow Rule Action Counts — response body — workflow rules workflow rules item conditions item instant actions actions count

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a summary of execution count entries for instant actions in a workflow rule condition, categorized by action type. Additional keys: not allowed
`actions_count`	array	Required within parent	Represents the list of action count entries, each categorized by action type, for the workflow rule. Maximum items: 10
`actions_count[]`	object	Each item	Represents a single action type entry containing the action name and its associated execution counts. Additional keys: not allowed
`actions_count[].type`	string	Required within parent	Represents the category of workflow action to which the execution count applies, such as email notifications, field updates, or webhooks. Known values: create_record, add_meeting, schedule_call, assign_owner, add_tags, remove_tags, convert, email_notifications, field_updates, tasks, webhooks, functions, sms, whatsapp, flow, circuits, slack_notifications, cliq_notifications, cisco_notifications, google_chat_notifications, microsoft_teams_notifications, create_record_email, create_connected_record, comment_to_post, reply_to_comment, like_to_comment, reply_to_message, retweet, reply_to_tweet
`actions_count[].value`	JSON	Required within parent
`actions_count[].value (anyOf 1)`	integer	Alternative	Represents the total execution count for the specified action type within the queried date range. Format: int32
`actions_count[].value (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Workflow Rule Quota and Usage Counts — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the response body containing the organization-level workflow rule quota and current usage counts. Additional keys: not allowed
`rules_count`	object	Required within parent	Represents the workflow rule count and limit details for the organization. Additional keys: not allowed
`rules_count.active_rules_configured`	JSON	Required within parent
`rules_count.active_rules_configured (anyOf 1)`	integer	Alternative	Represents the number of currently active workflow rules configured in the organization. Format: int32
`rules_count.active_rules_configured (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rules_count.active_rules_limit`	JSON	Required within parent
`rules_count.active_rules_limit (anyOf 1)`	integer	Alternative	Represents the maximum number of active workflow rules allowed in the organization. Format: int32
`rules_count.active_rules_limit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rules_count.active_rules_limit_per_module`	JSON	Required within parent
`rules_count.active_rules_limit_per_module (anyOf 1)`	integer	Alternative	Represents the maximum number of active workflow rules allowed per CRM module. Format: int32
`rules_count.active_rules_limit_per_module (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rules_count.rules_per_process_limit`	JSON	Required within parent
`rules_count.rules_per_process_limit (anyOf 1)`	integer	Alternative	Represents the maximum number of workflow rules allowed per business process. Format: int32
`rules_count.rules_per_process_limit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rules_count.scheduled_actions_per_rule_limit`	JSON	Required within parent
`rules_count.scheduled_actions_per_rule_limit (anyOf 1)`	integer	Alternative	Represents the maximum number of scheduled action groups allowed per workflow rule. Format: int32
`rules_count.scheduled_actions_per_rule_limit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rules_count.total_actions_per_rule_limit`	JSON	Required within parent
`rules_count.total_actions_per_rule_limit (anyOf 1)`	integer	Alternative	Represents the maximum total number of actions (instant and scheduled combined) allowed per workflow rule. Format: int32
`rules_count.total_actions_per_rule_limit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rules_count.total_rules_configured`	JSON	Required within parent
`rules_count.total_rules_configured (anyOf 1)`	integer	Alternative	Represents the total number of workflow rules configured in the organization, including both active and inactive rules. Format: int32
`rules_count.total_rules_configured (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rules_count.total_rules_limit`	JSON	Required within parent
`rules_count.total_rules_limit (anyOf 1)`	integer	Alternative	Represents the maximum total number of workflow rules allowed in the organization. Format: int32
`rules_count.total_rules_limit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`rules_count.total_rules_limit_per_module`	JSON	Required within parent
`rules_count.total_rules_limit_per_module (anyOf 1)`	integer	Alternative	Represents the maximum number of workflow rules allowed per CRM module. Format: int32
`rules_count.total_rules_limit_per_module (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List Workflow Rules in your Zoho CRM Organization — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the paginated list response for workflow rules, containing an array of workflow rule objects and pagination metadata. Additional keys: not allowed
`info`	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — info
`workflow_rules`	array	Required within parent	Represents the array of workflow rule objects returned in the list response. Maximum items: 200
`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 — info, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item

List Workflow Rules in your Zoho CRM Organization — response body — info

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the pagination metadata included in list response payloads, including the current page, records per page, total count, and whether more records exist. Additional keys: not allowed
`count`	JSON	Required within parent
`count (anyOf 1)`	integer	Alternative	Represents the total number of records matching the query. Format: int32
`count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`more_records`	boolean	Required within parent	Indicates whether more records exist beyond the current page.
`page`	JSON	Required within parent
`page (anyOf 1)`	integer	Alternative	Represents the current page number in the paginated response. Format: int32
`page (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`per_page`	JSON	Required within parent
`per_page (anyOf 1)`	integer	Alternative	Represents the number of records returned per page. Format: int32
`per_page (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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the full configuration and metadata of a single workflow rule, including its trigger, conditions, actions, lock status, and audit timestamps. Additional keys: not allowed
`category`	string	Optional	Represents the classification category of the workflow rule. Maximum length: 255
`conditions`	array	Optional	Represents the array of condition objects that define the criteria for executing the actions of the workflow rule. Maximum items: 10
`conditions[]`	Model	Each item	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item
`created_by`	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item created by
`created_time`	string	Required within parent	Represents the ISO 8601 timestamp indicating when the system created this workflow rule. Format: date-time Maximum length: 255
`deletable`	boolean	Required within parent	Indicates whether the requesting user has permission to delete this workflow rule.
`deprecated`	boolean	Optional	Indicates whether this workflow rule is deprecated and should be migrated to a newer configuration.
`description`	JSON	Required within parent
`description (anyOf 1)`	string	Alternative	Represents the user-defined description of the workflow rule. Null if not set. Maximum length: 255
`description (anyOf 2)`	null	Alternative	Represents the user-defined description of the workflow rule. Null if not set. Maximum length: 255
`editable`	boolean	Required within parent	Indicates whether the requesting user has permission to edit this workflow rule.
`execute_when`	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when
`id`	string	Required within parent	Represents the unique ID of the workflow rule. Maximum length: 20
`last_executed_time`	JSON	Required within parent
`last_executed_time (anyOf 1)`	string	Alternative	Represents the ISO 8601 timestamp of the last time this workflow rule was triggered. Null if the rule has never been triggered. Format: date-time
`last_executed_time (anyOf 2)`	null	Alternative	Represents the ISO 8601 timestamp of the last time this workflow rule was triggered. Null if the rule has never been triggered. Format: date-time
`lock`	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item lock
`modified_by`	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item created by
`modified_time`	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item modified time
`module`	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module
`name`	string	Required within parent	Represents the name of the workflow rule. Maximum length: 255
`source`	string	Required within parent	Represents the origin of the workflow rule. For example, crm for rules created through the CRM UI, or API for rules created through the API. Maximum length: 255
`status`	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item status

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item status, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item created by, 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, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item lock, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item modified time

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a single condition within a workflow rule that defines which records are evaluated and what actions are executed when the criteria are met. Additional keys: not allowed
`_delete`	null	Optional	Indicates that this condition should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
`criteria_details`	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item criteria details Record matching criteria for this condition. When provided, criteria_details must be a JSON object and cannot be null. To match all records, pass an object with criteria set to null, but do not set criteria_details itself to null. This field is required for certain trigger types, such as related module triggers like Notes on Leads. The convert action type requires criteria_details.criteria to be a non-null filter object. Omit criteria_details entirely or pass criteria as null to match all records when the trigger does not require specific criteria and no convert action is present.
`id`	string	Optional	Represents the unique ID of the condition. Auto-generated on creation. Required on PUT to identify which condition to update. Format: int64
`instant_actions`	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions Actions to execute immediately when the condition is met. At least one of instant_actions or scheduled_actions must be present - returns MANDATORY_NOT_FOUND if both are absent.
`scheduled_actions`	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions Actions to execute after a configured delay. Scheduled actions require both the trigger and the action type to support scheduling.
`sequence_number`	JSON	Required within parent
`sequence_number (anyOf 1)`	integer	Alternative	Represents the execution order of this condition within the workflow rule, starting from one. Must be unique across all conditions in the rule. Format: int32
`sequence_number (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item criteria details, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item scheduled actions

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item criteria details

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the filter criteria that determine which records satisfy the workflow rule condition. Additional keys: not allowed
`criteria`	JSON	Optional	Represents the filter criteria applied to the trigger module records. When null, the rule applies to all records without additional field-level filtering.
`criteria (anyOf 1)`	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item criteria details criteria value
`criteria (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
`criteria (anyOf 3)`	null	Alternative	Represents a null variant indicating no criteria or module filter is applied.
`relational_criteria`	object	Optional	Represents the filter criteria applied to a related module when the trigger involves cross-module data, such as emails, calls, or notes. Additional keys: not allowed
`relational_criteria.criteria`	JSON	Optional	Represents the filter criteria applied to the related module records. Follows the same structure as the top-level criteria field.
`relational_criteria.criteria (anyOf 1)`	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item criteria details criteria value
`relational_criteria.criteria (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
`relational_criteria.criteria (anyOf 3)`	null	Alternative	Represents a null variant indicating no criteria or module filter is applied.
`relational_criteria.module`	JSON	Optional	Represents the related module to filter on. Required when module_selection is set to specific.
`relational_criteria.module (anyOf 1)`	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module
`relational_criteria.module (anyOf 2)`	null	Alternative	Represents a null variant indicating no criteria or module filter is applied.
`relational_criteria.module_selection`	JSON	Optional
`relational_criteria.module_selection (anyOf 1)`	string	Alternative	Represents the scope selector for the related module filter. Required when relational_criteria is present. Known values: all, specific, unknown
`relational_criteria.module_selection (anyOf 2)`	null	Alternative	Represents the scope selector for the related module filter. Required when relational_criteria is present. Known values: all, specific, unknown

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 / 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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Represents a simple field-based filter criterion that dispatches to the appropriate comparator-specific schema. The equal and not_equal comparators support scalar or array values; text comparators support scalar or array strings; ordering comparators require a scalar; between and not_between comparators require a two-element array; in and not_in comparators require an array of primitives; and include_all, include_any, exclude_all, and exclude_any comparators require an array of lookup objects and apply only when the field's data_type is multiuserlookup or multiselectlookup.
`$ (anyOf 1)`	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item criteria details criteria value value
`$ (anyOf 2)`	Model	Alternative	Expand 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
`$ (anyOf 3)`	Model	Alternative	Expand 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
`$ (anyOf 4)`	Model	Alternative	Expand 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
`$ (anyOf 5)`	Model	Alternative	Expand 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
`$ (anyOf 6)`	Model	Alternative	Expand 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

Referenced models: 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, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item criteria details criteria 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, 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, 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, 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

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item criteria details criteria value value

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Represents an equality filter criterion that dispatches to either the EqualFilterCriterionRequest or NotEqualFilterCriterionRequest schema based on the comparator value.
`$ (anyOf 1)`	Model	Alternative	Expand 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
`$ (anyOf 2)`	Model	Alternative	Expand 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

Referenced models: 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, 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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the container for instant actions that execute immediately when the workflow rule condition is met. Additional keys: not allowed
`actions`	array	Required within parent	Represents the array of action objects configured for this condition. Required and must be non-empty. Each action object specifies the action type and its configuration or reference ID. 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

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 instant actions actions item value delete, details, id, name, type details notify to notify fields

Field	Type	Presence	Description and constraints
`$`	object	Root	Required for type='fields'. Field references to resolve notification recipients. Additional keys: not allowed
`fields`	array	Optional	Array of field references. Each must have api_name and optionally id. If both given, cross-validated for consistency (AMBIGUITY_DUE_TO if mismatch). Maximum items: 10
`fields[]`	object	Each item	A field reference with api_name and optional id. Additional keys: not allowed
`fields[].api_name`	string	Optional	Field API name. Use GET /settings/fields?module={api_name} to discover. Maximum length: 255
`fields[].id`	string	Optional	Field ID. Format: int64
`static_fields`	array	Optional	Array of static field references. Maximum items: 10
`static_fields[]`	object	Each item	A static field reference with api_name and optional id. Additional keys: not allowed
`static_fields[].api_name`	string	Optional	Static field API name. Maximum length: 255
`static_fields[].id`	string	Optional	Static field ID. Format: int64

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 details — Automation Chat Notification Details

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Details object for chat notification actions (slack/cliq/cisco/google_chat/microsoft_teams_notifications). Sends a message to a channel, user, or field-based recipient. Limit: 1 per type per rule. MANDATORY: message (string, supports ${Module.Field} merge fields), notify_to (object with type: 'user'\|'channel'\|'fields'). For user/channel: provide id + name. For fields: provide module + notify_fields.fields array. EXAMPLE: {"message": "New deal ${Deals.Deal_Name}", "notify_to": {"type": "channel", "id": "C0123", "name": "#sales"}} Additional keys: not allowed
`id`	string	Optional	Read-only. Unique identifier for the action, returned in GET responses. Maximum length: 20
`message`	string	Required within parent	REQUIRED. Notification message body. Supports merge fields in ${Module.Field} format (e.g., "New deal ${Deals.Deal_Name} created by ${Deals.Owner}!"). Maximum length: 5000
`notify_to`	object	Required within parent	REQUIRED. Notification target - a channel, user, or field-based recipient. Additional keys: not allowed
`notify_to.id`	string	Optional	Required for user/channel types. The integration-specific user or channel ID. Maximum length: 255
`notify_to.module`	object	Optional	Required for type='fields'. The CRM module to resolve field values from. Use GET /settings/modules to discover api_name and id. Additional keys: not allowed
`notify_to.module.api_name`	string	Optional	Module API name. Maximum length: 255
`notify_to.module.id`	string	Optional	Module ID. Format: int64
`notify_to.name`	string	Optional	Required for user/channel types. Display name of the user or channel (e.g., '#sales-alerts'). Maximum length: 255
`notify_to.notify_fields`	Model	Optional	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 details notify to notify fields
`notify_to.type`	string	Required within parent	Target type. 'user' - send to a specific chat user. 'channel' - send to a chat channel. 'fields' - send to users resolved from CRM field values. Known values: user, channel, fields

Referenced models: 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 details notify to notify fields

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 details — Automation Social Details

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Details object for social actions (Facebook/Twitter). Available only with fb_/tw_ triggers. Limit: 1 per type per rule. content is REQUIRED for comment_to_post, reply_to_comment, reply_to_message, reply_to_tweet. NOT required for like_to_comment, retweet. Supports ${Module.Field} merge fields. EXAMPLE: {"content": "Thanks ${Leads.Full_Name}!"} Additional keys: not allowed
`content`	string	Optional	Message content. Supports merge fields in ${Module.Field} format. REQUIRED for: comment_to_post, reply_to_comment, reply_to_message, reply_to_tweet. NOT required for: like_to_comment, retweet (details can be empty). Maximum length: 5000
`id`	string	Optional	Read-only. Unique identifier for the action. Maximum length: 20

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that sends a chat notification to an integrated chat service, such as Slack or Zoho Cliq, 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`	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 delete, details, id, name, type details — Automation Chat Notification Details Configuration for the chat notification action. Requires a message, which supports merge fields, and a target channel, user, or field to notify.
`id`	string	Optional	Represents the unique ID of the ChatNotification action within the workflow rule. Maximum length: 20
`name`	string	Required within parent	Represents the display name of the ChatNotification action. This field is required. Maximum length: 100
`type`	string	Required within parent	Represents chat service type. Each service has a limit of 1 action per rule. Known values: slack_notifications, cliq_notifications, cisco_notifications, google_chat_notifications, microsoft_teams_notifications

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that publishes a post to a social network such as Facebook or Twitter 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`	Model	Optional	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 details — Automation Social Details Configuration for the social action, containing the message content with merge field support. Required for commenting or replying actions, and not needed for like or retweet actions.
`id`	string	Optional	Represents the unique ID of the Social action within the workflow rule. Maximum length: 20
`name`	string	Optional	Represents the display name of the Social action as it appears within the workflow rule configuration. Maximum length: 100
`type`	string	Required within parent	Represents the social action type. Facebook actions require Facebook-specific triggers, and Twitter actions require Twitter-specific triggers. Known values: comment_to_post, reply_to_comment, like_to_comment, reply_to_message, retweet, reply_to_tweet

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that schedules a meeting when the workflow rule condition is triggered. Additional keys: not allowed
`_delete`	null	Optional	Indicates that this add-meeting action should be removed from the workflow rule when set in a PUT request. When this field is provided with a null value, the platform interprets it as a deletion signal and removes the action from the rules action list.
`details`	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 Configuration for the add_meeting action. Requires the Events module, a layout, and field mappings that include the event title and start date and time. Also requires the meeting duration, unless the event is set to all day, and specifies whether the record owner or another assigned user hosts the meeting. Optionally restricts creation to prevent duplicate records.
`id`	string	Optional	Represents the unique ID of the add-meeting action within the workflow rule. Maximum length: 20
`name`	string	Optional	Represents the display name of the add-meeting action as it appears within the workflow rule configuration. Maximum length: 100
`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 convert related details Optional. For add_meeting, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only).
`type`	string	Required within parent	Represents the action type discriminator that identifies this action as an add-meeting action within the workflow rule. The value is fixed for this action type and must correspond to a type supported by the target module and trigger event. Must equal: add_meeting

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Details object for add_meeting action. Creates an Event record when workflow fires. PREREQUISITES: GET /settings/layouts?module=Events for layout + mandatory fields. GET /settings/fields?module=Events for field ids. MANDATORY: module ({api_name: 'Events', id}), layout ({id}), field_mappings (array 1-25, include Event_Title, Start_DateTime), meeting_duration ({unit: int, period: 'hours'\|'minutes'} - NOT when All_Day=true), host_unavailable ({assign_record_owner_as_host: true} or {assign_task: {id}}). OPTIONAL: apply_restriction (bool). 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 Event 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 Event 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 Event. Each entry: {"field": {"api_name": "Event_Title"}, "type": "static", "value": "Meeting"}. Must include all mandatory fields from GET /settings/layouts?module=Events. Common fields: Event_Title, Start_DateTime, All_Day, Participants (composite type), Remind_At. End_DateTime is auto-computed from Start_DateTime + meeting_duration - do NOT provide it. Mapping types: static - literal values for text, picklist fields; NOT for DateTime/ALARM (DEPENDENT_MISMATCH). merge_field - runtime tokens like ${!Leads.Company} for text-based fields; NOT for lookup/owner (DEPENDENT_MISMATCH). execution_time - REQUIRED for Start_DateTime and Remind_At; sign required for datetime; periods: days, business_days, hours, minutes. When All_Day=true, period must be "days" and omit meeting_duration. 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 Event record, conforming to the AutomationFieldMappings schema. Each entry identifies a target Event 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.
`host_unavailable`	Model	Optional	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 host unavailable Fallback behavior when the designated meeting host is unavailable. Either assign the record owner as host (assign_record_owner_as_host=true) or create a follow-up task (assign_task with a pre-configured task ID). Exactly one option must be specified; providing both returns INVALID_DATA with field1/field2 conflict, providing neither returns EXPECTED_FIELD_MISSING.
`id`	string	Optional	Server-generated unique identifier for this add meeting 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 Event record. Determines which fields are available and their validation rules. Fetch valid layouts from GET /settings/layouts?module=Events. The layout.id is required.
`meeting_duration`	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 meeting duration Duration of the meeting. Specifies a numeric value and time period (e.g., 1 hour, 30 minutes). Required when All_Day is not set to true in field_mappings. If All_Day is true, meeting_duration must not be provided - the API returns INVALID_DATA with field1/field2 conflict details.
`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 meeting. Must be the Events module. Provide either api_name ("Events") or the Events 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 host unavailable, 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 add meeting details meeting duration

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type add meeting details host unavailable

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Fallback when meeting host or caller is unavailable. Exactly ONE must be specified: assign_record_owner_as_host (bool) OR assign_task ({id}). Both = INVALID_DATA. Neither = EXPECTED_FIELD_MISSING. Additional keys: not allowed
`assign_record_owner_as_host`	boolean	Optional	When true, the record owner is automatically assigned as the host/caller if the originally designated host is unavailable. Mutually exclusive with assign_task.
`assign_task`	JSON	Optional
`assign_task (anyOf 1)`	object	Alternative	A follow-up task to create when the host is unavailable. Mutually exclusive with assign_record_owner_as_host. The task must be pre-configured in the CRM. Additional keys: not allowed
`assign_task (anyOf 1).id`	string	Required within parent	Unique ID of the pre-configured task. Maximum length: 20
`assign_task (anyOf 1).name`	string	Optional	Name of the follow-up task. Maximum length: 255
`assign_task (anyOf 2)`	null	Alternative	A follow-up task to create when the host is unavailable. Mutually exclusive with assign_record_owner_as_host. The task must be pre-configured in the CRM. Additional keys: not allowed
`assign_task (anyOf 2).id`	string	Required within parent	Unique ID of the pre-configured task. Maximum length: 20
`assign_task (anyOf 2).name`	string	Optional	Name of the follow-up task. Maximum length: 255

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

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Meeting duration for add_meeting. MANDATORY unless All_Day=true. REQUIRED: unit (integer - quantity), period (string - 'hours' or 'minutes'). Must be a JSON object (not int/string - INVALID_DATA). Omitting returns MANDATORY_NOT_FOUND. If All_Day=true and provided, returns INVALID_DATA (field1/field2 conflict). EXAMPLE: {"unit": 1, "period": "hours"} Additional keys: not allowed
`period`	string	Required within parent	The time unit for the duration. "hours" - duration in hours (e.g., unit=1, period=hours means a 1-hour meeting). "minutes" - duration in minutes (e.g., unit=30, period=minutes means a 30-minute meeting). Known values: hours, minutes Maximum length: 10
`unit`	JSON	Required within parent
`unit (anyOf 1)`	integer	Alternative	The numeric duration value (e.g., 1, 2, 30). 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 type add tags

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that adds pre-existing tags to the triggering record when the workflow rule condition is met. Additional keys: not allowed
`_delete`	null	Optional	Indicates that this add-tags action should be removed from the workflow rule when set in a PUT request. When this field is provided with a null value, the platform interprets it as a deletion signal and removes the action from the rules action list.
`details`	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 tags details
`id`	string	Optional	Represents the unique ID of the add-tags action within the workflow rule. Maximum length: 20
`name`	string	Optional	Represents the display name of the add-tags action as it appears within the workflow rule configuration. Maximum length: 100
`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 convert related details Optional. For add_tags, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only).
`type`	string	Required within parent	Represents the action type discriminator that identifies this action as an add-tags action within the workflow rule. The value is fixed for this action type and must correspond to a type supported by the target module and trigger event. Must equal: add_tags

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Details object for add_tags action. Adds pre-existing tags to the triggering record. PREREQUISITES: Tags must exist - GET /settings/tags?module={api_name} to list, POST to create first. MANDATORY: tags (array 1-10, each {id, name}). OPTIONAL: over_write (bool, default false - true replaces ALL existing tags), module ({api_name, id}). CONSTRAINTS: Not allowed with convert on Leads (AMBIGUITY_DURING_PROCESSING). over_write=true + remove_tags in same rule = INVALID_DATA. Unsupported: Visits, Users, LinkingModules (NOT_ALLOWED). Additional keys: not allowed
`id`	string	Optional	Server-generated unique identifier for this add tags action. Present only in GET responses; not required in POST requests. Maximum length: 20
`module`	Model	Optional	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details module Target module for the tag action. Must match the workflow rule's trigger module. Supported modules: Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price_Books, Quotes, Sales_Orders, Purchase_Orders, Invoices, and custom modules. Unsupported modules (Visits, Users, LinkingModules) return NOT_ALLOWED.
`over_write`	boolean	Optional	Whether to overwrite all existing tags on the record with the specified tags (true) or append to existing tags (false). Default is false. When set to true, any RemoveTags action in the same workflow rule becomes invalid and returns INVALID_DATA ('Remove tag not supported with Overwrite Add Tag'). Default: false
`tags`	array	Required within parent	List of tags to add to the record. All tags must pre-exist in the org - fetch available tags from GET /settings/tags?module={module_api_name}. To create new tags: POST /settings/tags?module={module_api_name}. If the list is empty after parsing, the API returns FAILURE ('Empty Tag'). If the tag count exceeds the edition limit, the API returns FAILURE ('Invalid Tag Count'). Maximum items: 10 Minimum items: 1
`tags[]`	Model	Each item	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type add tags details tags item Represents a tag reference, conforming to the AutomationTagRef schema, that identifies a pre-existing org tag to be added to the record. Both id and name are mandatory fields on each entry; the referenced tag must already exist in the org before the action executes.

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Tag reference for add_tags/remove_tags. Tags must pre-exist - GET /settings/tags?module={api_name} to list, POST to create. MANDATORY: id, name. Both must resolve to same tag (AMBIGUITY_DURING_PROCESSING if mismatch). Non-existent = INVALID_DATA. Limits: 100 tags/module, 10 tags/record, name max 25 chars. Additional keys: not allowed
`color_code`	string	Optional	Hex color code of the tag (e.g., '#879BFC'). Optional in requests; present in GET responses. Allowed values: #F17574, #F48435, #E7A826, #A8C026, #63C57E, #1DB9B4, #57B1FD, #879BFC, #D297EE, #FD87BD, #969696, #658BA8, #B88562. Maximum length: 25
`id`	string	Required within parent	Unique identifier of the tag. Obtain from GET /settings/tags?module={module_api_name}. If provided alone, the tag is resolved by ID. If both id and name are provided, they must resolve to the same tag. Maximum length: 20
`name`	string	Required within parent	Name of the tag. Obtain from GET /settings/tags?module={module_api_name}. If provided alone, the tag is resolved by name. Must match an existing tag - providing a non-existent name returns INVALID_DATA. Max 25 characters, cannot contain <, >, commas, or emojis. Maximum length: 25

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that assigns or reassigns the record owner 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`	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 Configuration for the assign_owner action. Requires a module reference and an assign_to array with one to five entries, each specifying who to assign the record to — a user, role, group, assignment rule, or profile, a merge field, or matching criteria. Optionally sends a notification, includes related records, applies an assignment threshold, or bases assignment on user availability.
`id`	string	Optional	Represents the unique ID of the AssignOwner action within the workflow rule. Maximum length: 20
`name`	string	Optional	Represents the display name of the AssignOwner action as it appears within the workflow rule configuration. Maximum length: 100
`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 convert related details Optional. For assign_owner, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only).
`type`	string	Required within parent	Represents the action type discriminator that identifies this as a AssignOwner 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: assign_owner

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Details object for assign_owner action. Assigns/reassigns record owner via user, role, group, profile, assignment_rule, merge_field, or criteria. MANDATORY: module ({api_name, id} - must match trigger module), assign_to (array 1-5 entries). OPTIONAL: notify (bool), related_records ([{api_name, id}] - Tasks/Calls/Events), apply_assignment_threshold (bool), user_availability_based_on, lookup_field (for cross-module). EXAMPLE: {"module": {"api_name": "Leads", "id": "111111000000000175"}, "assign_to": [{"type": "user", "resource": {"id": "111111000000050001", "name": "John"}}], "notify": true} Additional keys: not allowed
`apply_assignment_threshold`	boolean	Optional	Whether to enforce assignment-threshold rules (record count limits per user) when assigning ownership. When true, the system checks whether the new owner has reached their record limit before applying the assignment. Only effective when the org has assignment thresholds configured. Default: false
`assign_to`	array	Required within parent	Specifies how the new owner is determined. Each entry defines an assignment method - a specific user, role, group, assignment rule, profile, merge field, or criteria-based filter. For round-robin assignment across multiple users, provide multiple entries of type=user. For criteria-based assignment, provide a single entry of type=criteria with filter conditions. Maximum items: 5 Minimum items: 1
`assign_to[]`	JSON	Each item	Represents a single owner-assignment entry that determines how the new record owner is resolved. Each entry is one of three variants: AutomationAssignToResourceEntry (assigns ownership to a specific user, role, group, assignment rule, or profile), AutomationAssignToMergeFieldEntry (resolves the owner at runtime from a user-type lookup field on the trigger record), or AutomationAssignToCriteriaEntry (determines the owner by evaluating filter criteria at runtime).
`assign_to[] (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 / details / assign_to / item / type: user, role, group, assignment rule, profile
`assign_to[] (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 assign owner details assign to item type merge field
`assign_to[] (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 assign owner details assign to item type criteria
`id`	string	Optional	Server-generated unique identifier for this assign owner action. Present only in GET responses; not required in POST or PUT requests. Maximum length: 20
`lookup_field`	Model	Optional	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 lookup field The lookup field linking the trigger module to the target module. Required only for cross-module assign owner actions (where the action's module differs from the workflow rule's trigger module). For same-module assignments, this field is omitted and the action operates directly on the triggering record.
`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 ownership assignment. Must match the workflow rule's trigger module for direct assignments, or the lookup field's related module for cross-module assignments. At least api_name or id must be provided; if both are given and they do not match, the API returns AMBIGUITY_DURING_PROCESSING.
`notify`	boolean	Optional	Whether to send an email notification to the new owner when the record is reassigned. When true, the newly assigned owner receives an email informing them of the ownership change. Default: false
`related_records`	JSON	Optional
`related_records (anyOf 1)`	array	Alternative	Related modules whose open record ownership should also be transferred when the parent record is reassigned. Common activity modules (Tasks, Calls, Events) are available for all modules. Additional modules depend on the parent module: Accounts can also include Contacts and Deals; Contacts can also include Deals. Null when no related modules are selected for ownership transfer. Maximum items: 5
`related_records (anyOf 1)[]`	Model	Each item	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 related records null item
`related_records (anyOf 2)`	null	Alternative	Related modules whose open record ownership should also be transferred when the parent record is reassigned. Common activity modules (Tasks, Calls, Events) are available for all modules. Additional modules depend on the parent module: Accounts can also include Contacts and Deals; Contacts can also include Deals. Null when no related modules are selected for ownership transfer. Maximum items: 5
`related_records (anyOf 2)[]`	Model	Each item	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 related records null item
`user_availability_based_on`	JSON	Optional
`user_availability_based_on (anyOf 1)`	array	Alternative	Restricts assignment to users who are currently available. When set to ["online_status"], only users logged in to the Zoho CRM web interface are eligible for assignment. If the selected user is offline, the assignment is skipped or deferred. Null means no availability check is applied. Maximum items: 1
`user_availability_based_on (anyOf 1)[]`	string	Each item	Availability criterion. Currently only "online_status" is supported - restricts to users currently logged in to Zoho CRM web interface. Known values: online_status
`user_availability_based_on (anyOf 2)`	null	Alternative	Restricts assignment to users who are currently available. When set to ["online_status"], only users logged in to the Zoho CRM web interface are eligible for assignment. If the selected user is offline, the assignment is skipped or deferred. Null means no availability check is applied. Maximum items: 1
`user_availability_based_on (anyOf 2)[]`	string	Each item	Availability criterion. Currently only "online_status" is supported - restricts to users currently logged in to Zoho CRM web interface. Known values: online_status

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 merge field, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type assign owner details lookup field, Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details module, 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 criteria, 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, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type assign owner details related records null 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 criteria

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: assign_to entry for criteria-based ownership. Evaluates filter criteria against the triggering record at execution time. MANDATORY: type (const 'criteria'), details.criteria (filter condition - simple or grouped with AND/OR). Criteria fields must reference valid trigger module fields - GET /settings/fields?module={api_name}. 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
`details`	object	Required within parent	Contains the filter criteria to evaluate against the triggering record. Additional keys: not allowed
`details.criteria`	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 criteria details criteria Filter criteria defining when this assignment applies. Can be a simple condition (field + comparator + value) or a grouped condition (group_operator + group array). The field references in criteria must be valid fields of the trigger module - fetch available fields from GET /settings/fields?module={module_api_name}. For example: {"field": {"api_name": "Department"}, "comparator": "equal", "value": "Engineering"} assigns ownership when the record's Department is Engineering.
`resource`	null	Optional	Always null for criteria-based assignments. The owner is determined by the criteria evaluation logic.
`type`	string	Required within parent	Assignment method indicating criteria-based evaluation. Must equal: criteria

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 criteria details criteria

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Represents the top-level filter criterion for data selection, supporting both simple field-based filters and complex grouped filters with logical operators.
`$ (anyOf 1)`	Model	Alternative	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item criteria details criteria value
`$ (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

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 instant actions actions item value type assign owner details assign to item type merge field

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: assign_to entry for merge-field-based ownership. Resolves to a user at execution time from a user-type field. MANDATORY: type (const 'merge_field'), details.api_name (merge field token e.g., '${!Leads.Created_By}'). Field must be data_type=ownerlookup or userlookup. GET /settings/fields?module={api_name} to discover. 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
`details`	object	Required within parent	Contains the merge field reference that resolves to a user at execution time. Additional keys: not allowed
`details.api_name`	string	Required within parent	Merge field token referencing a user-type field. Must use the format ${!Module.User_Field} ,${!Module.Lookup_Field_API_Name.User_Field} where Field is a user-type field (data_type=ownerlookup or userlookup) from the trigger module. Fetch valid fields from GET /settings/fields?module={module_api_name}. Common user-type fields: Owner, Created_By, Modified_By. Examples: ${!Leads.Created_By}, ${!Deals.Owner}, ${!Contacts.Account_Manager}. Maximum length: 255
`resource`	null	Optional	Always null for merge field assignments. The owner is resolved dynamically from the merge field at execution time.
`type`	string	Required within parent	Assignment method indicating merge field resolution. Must equal: merge_field

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type assign owner details lookup field

Field	Type	Presence	Description and constraints
`$`	object	Root	Identifies a lookup field that links the workflow rule's trigger module to the target module of a cross-module action. For example, if the trigger module is Leads and the assign owner action targets Contacts, the lookup_field identifies which lookup field on Leads points to Contacts (e.g., Lookup_2_cont). Minimum fields: 1 Additional keys: not allowed
`api_name`	string	Optional	API name of the lookup field (e.g., Lookup_1_same, Lookup_2_cont). Maximum length: 255
`id`	string	Optional	Unique field ID of the lookup field. Maximum length: 20

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Identifies a related module whose open records' ownership should be transferred alongside the parent record. Used by assign_owner actions, field_updates (Owner field), and convert actions (change_owner.related_modules). Common activity modules (Tasks, Calls, Events) are available for all modules and actions. Contacts is available for assign_owner when parent is Accounts, and for convert when converting Leads. Deals is available for assign_owner when parent is Accounts or Contacts, and for convert when converting Leads (requires create_deal=true). Additional keys: not allowed
`api_name`	string	Required within parent	API name of the related module. Events, Calls, Tasks - open activity records, available for all modules and actions (assign_owner, convert). Contacts - available for assign_owner when parent is Accounts, and for convert when converting Leads. Deals - available for assign_owner when parent is Accounts or Contacts, and for convert when converting Leads (requires create_deal=true). Known values: Events, Calls, Tasks, Contacts, Deals Maximum length: 255
`id`	string	Optional	Unique identifier of the related module. This is the module ID corresponding to the api_name. Maximum length: 255

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that executes a Zoho Circuits workflow 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`	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 circuits details Configuration for the Zoho Circuits action. Requires the ID of the circuit to execute.
`id`	string	Optional	Represents the unique ID of the Circuits action within the workflow rule. Maximum length: 20
`name`	string	Required within parent	Represents the display name of the Circuits action. This field is required. Maximum length: 100
`type`	string	Required within parent	Represents the action type discriminator that identifies this as a Circuits 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: circuits

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Details object for circuits action. Executes a Zoho Circuits workflow. Limit: 1/rule. MANDATORY: circuit_id (string). EXAMPLE: {"circuit_id": "7389640000001234"} Additional keys: not allowed
`circuit_id`	string	Required within parent	REQUIRED. Zoho Circuits circuit ID. Maximum length: 255
`id`	string	Optional	Read-only. Unique identifier for the action. Maximum length: 20

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that converts a record to another module type, such as converting a lead to a contact, account, and deal. 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`	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 convert details Configuration for converting records. This action is only available when the trigger module is Leads, Quotes, or Sales_Orders. The convert action requires non-null criteria in the condition; null criteria will result in a dependent field missing error. For Leads conversion, the following fields are mandatory: add_to_existing_contact, add_to_existing_account, apply_restriction, and change_owner which is an object containing the apply_assignment_threshold flag. Key optional fields include create_deal for creating a deal, carry_tags which is an array of module references and not a boolean, field_mappings with a maximum of 25 entries, move_attachment_to for specifying a target module, contact_role which is applicable only when create_deal is true, and convert_to which is used for Quotes and SalesOrders conversions. Example configuration for a Leads conversion without creating a deal.
`id`	string	Optional	Represents the unique ID of the Convert action within the workflow rule. Maximum length: 20
`name`	string	Optional	Represents the display name of the Convert action as it appears within the workflow rule configuration. Maximum length: 100
`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 convert related details Optional. For convert, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only).
`type`	string	Required within parent	Represents the action type discriminator that identifies this as a Convert 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: convert

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Details object for convert action. Converts records - Leads to Contacts+Accounts+Deals, Quotes to SalesOrders/Invoices, SalesOrders to Invoices. PREREQUISITES: criteria_details.criteria MUST be non-null (NOT_ALLOWED otherwise). Module MUST be Leads/Quotes/Sales_Orders. MANDATORY (Leads): add_to_existing_contact (bool), add_to_existing_account (bool). MANDATORY (Quotes/Sales_Orders): convert_to ({api_name, id}). OPTIONAL: change_owner, carry_tags (ARRAY [{api_name, id}] NOT boolean), field_mappings (max 25), move_attachment_to, create_deal (Leads only), contact_role (with create_deal). CONSTRAINTS: No add_tags/remove_tags with convert on Leads. No scheduled actions with convert. Additional keys: not allowed
`add_to_existing_account`	boolean	Optional	MANDATORY for Leads conversion (omitting returns MANDATORY_NOT_FOUND). Whether to link the converted record to an existing Account instead of creating a new one. Only applicable for Leads module. When true, if a matching Account exists (based on Company name), the Lead is linked to it rather than creating a new Account. Not applicable for Quotes or Sales_Orders conversions. Default: false
`add_to_existing_contact`	boolean	Optional	MANDATORY for Leads conversion (omitting returns MANDATORY_NOT_FOUND). Whether to link the converted record to an existing Contact instead of creating a new one. Only applicable for Leads module. When true, if a matching Contact exists (based on duplicate-check criteria), the Lead is merged into it rather than creating a new Contact. Not applicable for Quotes or Sales_Orders conversions. Default: false
`apply_restriction`	JSON	Optional
`apply_restriction (anyOf 1)`	boolean	Alternative	Whether to enforce assignment-threshold rules on the record owner during conversion. Present in GET responses. Default: false
`apply_restriction (anyOf 2)`	null	Alternative	Whether to enforce assignment-threshold rules on the record owner during conversion. Present in GET responses. Default: false
`carry_tags`	array	Optional	List of target modules that should inherit tags from the source record during conversion. For Leads: may include Contacts, Accounts, Deals. Each entry identifies a module by api_name and/or id. Maximum items: 10
`carry_tags[]`	Model	Each item	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details module Represents a module reference, conforming to the AutomationModuleRef schema, that identifies a target module whose records should inherit tags from the source record during conversion. At least one of api_name or id is required to identify the module; valid values are obtainable from GET /settings/modules.
`change_owner`	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type convert details change owner New owner assignment for the converted records. Specifies the user (by id) who should own the converted records, which modules should receive the new owner (via related_modules), and whether to enforce assignment thresholds. When omitted, the source record's owner is retained.
`contact_role`	string	Optional	Unique ID of the Contact Role to assign when a Deal is created during Leads conversion. Only applicable when create_deal=true. Obtain valid Contact Role IDs from GET /Contacts/roles. Maximum length: 20
`convert_to`	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type convert details convert to
`create_deal`	boolean	Optional	Whether to create a Deal record as part of Leads conversion. Only applicable when the trigger module is Leads. When true, the Deal module field mappings in field_mappings are used to populate the new Deal. Default: false
`field_mappings`	array	Optional	List of field-value pairs to populate in the converted record(s). Each entry maps a target field to a value using one of the supported types: static, merge_field, or execution_time. For Leads conversion, field mappings can target Contacts, Accounts, and Deals modules. Fetch available fields from GET /settings/fields?module={target_module_api_name}. Maximum items: 25
`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 converted record, conforming to the AutomationFieldMappings schema. Each entry identifies the target field and specifies the value resolution strategy: static for literal values, merge_field for runtime token substitution, or execution_time for dynamically resolved values.
`id`	string	Optional	Server-generated unique identifier for this convert action. Present only in GET responses; not required in POST requests. Maximum length: 20
`move_attachment_to`	Model	Optional	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details module Target module to which attachments from the source record should be moved during conversion. For Leads: typically Contacts or Accounts. For Quotes/SalesOrders: the target conversion module. Provide api_name and/or id.
`portal_user_type`	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type convert details portal user type

Referenced models: Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details module, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type convert details change owner, 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 convert details convert to, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type convert details portal user type

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Owner assignment during convert action. MANDATORY: id (user ID from GET /users). OPTIONAL: name, related_modules ([{api_name, id}] - which converted modules get new owner), apply_assignment_threshold (bool). For Leads: related_modules can include Events, Calls, Tasks, Contacts, Deals. Additional keys: not allowed
`apply_assignment_threshold`	boolean	Optional	Whether to enforce assignment-threshold rules (record count limits per user) on the new owner for each converted module. When true, the system checks whether the new owner has reached their record limit before assigning ownership. Default: false
`id`	string	Required within parent	Unique user ID of the new owner. Obtain from GET /users. Must be an active user with permissions on the target modules. Maximum length: 20
`name`	string	Optional	Full name of the new owner. Optional - present in GET responses for display purposes. Maximum length: 255
`related_modules`	array	Optional	List of target modules whose records should receive the new owner during conversion. Reuses the same related-record concept as assign_owner. For Leads conversion: Events, Calls, Tasks, Contacts, Deals are valid. For Quotes/SalesOrders conversion: only Events, Calls, Tasks are valid. Maximum items: 10
`related_modules[]`	Model	Each item	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 related records null item Represents a related module reference, conforming to the AutomationRelatedRecord schema, that identifies a child module whose records should also receive the new owner assignment during the conversion operation. At least one of api_name or id is required to identify the child module.

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

Field	Type	Presence	Description and constraints
`$`	object	Root	MANDATORY for Quotes and Sales_Orders conversion (omitting returns MANDATORY_NOT_FOUND). Identifies the target module for conversion as an object with api_name and id. For Quotes: convert_to can be {api_name: 'SalesOrders', id: '<module_id>'} or {api_name: 'Invoices', id: '<module_id>'}. For Sales_Orders: convert_to must be {api_name: 'Invoices', id: '<module_id>'}. Obtain the module id from GET /settings/modules. Not applicable for Leads conversion (Leads always convert to Contacts+Accounts, optionally +Deals). Additional keys: not allowed
`api_name`	string	Required within parent	API name of the target module. For Quotes: 'SalesOrders' or 'Invoices'. For Sales_Orders: 'Invoices'. Maximum length: 50
`id`	string	Required within parent	Unique 19-digit module ID of the target module. Obtain from GET /settings/modules. Always use the full 19-digit ID as returned by the API; truncated IDs cause INVALID_DATA. Maximum length: 20

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Portal user type to assign during Leads conversion. Only applicable when the org has portals configured and the converted Contact should be provisioned as a portal user. The id and name must match an existing portal user type - validated against the org's portal metadata (CrmClientPortalFilterUtil). Not applicable for Quotes or Sales_Orders conversions. Additional keys: not allowed
`id`	string	Required within parent	Unique identifier of the portal user type. Must match an existing portal user type in the org's portal configuration. Maximum length: 20
`name`	string	Required within parent	Display name of the portal user type. Maximum length: 100

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

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Represents the optional action-specific configuration attached to an associate action, such as best-time delivery settings for email notifications or lookup field references for field updates.
`$ (anyOf 1)`	object	Alternative	Represents the email notification related details, including best-time delivery configuration. Additional keys: not allowed
`$ (anyOf 1).best_time`	boolean	Optional	Indicates whether to send the email notification at the best time for the recipient. When set to true, the platform determines the optimal send time.
`$ (anyOf 2)`	object	Alternative	Represents the task related details, including followup task configuration. Additional keys: not allowed
`$ (anyOf 2).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 3)`	object	Alternative	Represents the field update related details, including the lookup field for cross-module updates. Additional keys: not allowed
`$ (anyOf 3).lookup_field`	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module The lookup field linking the rule module to the target module (e.g., Account_Name on Contacts). Provide the field's id and api_name. When the field update targets the same module, related_details is null.
`$ (anyOf 4)`	null	Alternative	Represents a null value indicating no related details are configured for this action.

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 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 create connected record

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that creates a connected record in a child module 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`	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 create connected record details Configuration for the create_connected_record action. Uses the same structure as create_record — module, layout, and field mappings — but the module must be a valid connected-record child module. Not supported for the Notes, Rebuy, or Competitor Mentions modules.
`id`	string	Optional	Represents the unique ID of the CreateConnectedRecord action within the workflow rule. Maximum length: 20
`name`	string	Optional	Represents the display name of the CreateConnectedRecord action as it appears within the workflow rule configuration. Maximum length: 100
`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 convert related details Optional. Not typically used for create_connected_record.
`type`	string	Required within parent	Represents the action type discriminator that identifies this as a CreateConnectedRecord 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: create_connected_record

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Details object for create_connected_record action. Same as create_record but module must be a connected-record child of the rule's module. Requires ManageAutomation or ManageConnectedWorkflow permission. Not for Notes, Rebuy, Competitor Mentions. Limit: 1/rule. MANDATORY: module ({api_name, id} of child), layout ({id}), field_mappings (array 1-25, include all mandatory fields). OPTIONAL: apply_restriction (bool). Additional keys: not allowed
`apply_restriction`	boolean	Optional	Apply assignment/workflow restrictions. Default true.
`field_mappings`	array	Required within parent	REQUIRED. Field mapping array (1-25 entries). Use GET /settings/fields?module={api_name} to discover field api_name and id. All mandatory fields for the target module/layout must be included. Maximum items: 25
`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 connected record, conforming to the AutomationFieldMappings schema. Each entry identifies a target field via its api_name and id, and specifies the value resolution strategy: static for literal values, merge_field for runtime token substitution, execution_time for dynamically resolved values, or composite for compound values.
`id`	string	Optional	Read-only. Unique identifier for the action. 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 Represents a layout reference, conforming to the AutomationLayoutRef schema, that determines which layout is applied when creating the connected record. The id field is mandatory and governs which fields are available and required for the target module; valid layout identifiers are obtainable from GET /settings/layouts?module={api_name}.
`module`	object	Required within parent	REQUIRED. Target child module for connected record creation. Must be a valid connected-record child module of the rule's module. Use GET /settings/modules to discover api_name and id. Additional keys: not allowed
`module.api_name`	string	Required within parent	Module API name. Maximum length: 255
`module.id`	string	Optional	Module ID. Format: int64

Referenced models: 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 create record

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that creates a new record in a specified CRM module 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`	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 create record details Configuration for the create_record action. Requires a module, a layout, and one to twenty-five field mappings that supply values for the new record fields, using a static value, a merge field, an execution-time offset, or a composite value. All fields marked mandatory by the layout must be included. Optionally restricts creation to prevent duplicate records.
`id`	string	Optional	Represents the unique ID of the CreateRecord action within the workflow rule. Maximum length: 20
`name`	string	Optional	Represents the display name of the CreateRecord action as it appears within the workflow rule configuration. Maximum length: 100
`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 convert related details Optional. For create_record, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only).
`type`	string	Required within parent	Represents the action type discriminator that identifies this as a CreateRecord 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: create_record

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Details object for create_record action. Creates a record in a module with field values from static data, merge fields, or execution-time refs. NOT for Tasks/Events/Calls (use tasks, add_meeting, schedule_call). PREREQUISITES: GET /settings/modules for id. GET /settings/layouts?module={api_name} for layout + mandatory fields. GET /settings/fields?module={api_name} for field ids. MANDATORY: module ({api_name, id}), layout ({id}), field_mappings (array 1-25, include all mandatory fields). OPTIONAL: apply_restriction (bool). EXAMPLE: {"module": {"api_name": "Contacts", "id": "111111000000000129"}, "layout": {"id": "111111000000000403"}, "field_mappings": [{"field": {"api_name": "Last_Name"}, "type": "merge_field", "value": "${!Leads.Last_Name}"}]} 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 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 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 record. Each entry: {"field": {"api_name": "Last_Name"}, "type": "static", "value": "Test"}. Must include all mandatory fields (system_mandatory=true or api_mandatory=true from GET /settings/layouts?module={module}) - missing ones cause REQUIRED_DATA_NOT_FOUND. Mapping types: static - literal values for text, picklist, phone, number fields; NOT for Date/DateTime/ALARM (DEPENDENT_MISMATCH) or unique fields (INVALID_DATA, check unique=true in GET /settings/fields). merge_field - runtime tokens like ${!Leads.Company} for text-based fields; NOT for lookup/owner fields (DEPENDENT_MISMATCH). execution_time - REQUIRED for Date/DateTime/ALARM fields; periods: days, business_days, hours, minutes; sign required for datetime fields. 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 record, conforming to the AutomationFieldMappings schema. Each entry identifies the target field via a field reference and specifies the value resolution strategy through a type discriminator: static for literal values, merge_field for runtime token substitution, execution_time for dynamically resolved values, or composite for compound values.
`id`	string	Optional	Server-generated unique identifier for this create record 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 record. Determines which fields are available and their validation rules. Fetch valid layouts from GET /settings/layouts?module={module_api_name}. 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 in which the new record will be created. Supported modules: Leads, Contacts, Potentials (Deals), Accounts, Products, Cases, custom modules, and team modules. NOT supported: Tasks, Events, Calls - use add_meeting for Events and schedule_call for Calls. Fetch available modules from GET /settings/modules. At least api_name or id must be provided; always use the full 19-digit module ID as returned by the modules API.

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that creates a record via an email-based trigger, applicable to modules such as Leads or Contacts. 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`	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 create record email details Configuration for the create-record-from-email action. Requires the target module, either Leads or Contacts, and exactly one field mapping that assigns the record owner.
`id`	string	Optional	Represents the unique ID of the EmailCreateRecord action within the workflow rule. Maximum length: 20
`name`	string	Optional	Represents the display name of the EmailCreateRecord action as it appears within the workflow rule configuration. Maximum length: 100
`type`	string	Required within parent	Represents the action type discriminator that identifies this as a EmailCreateRecord 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: 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 create record email details

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Details object for create_record_email action. Creates a record via email for Leads or Contacts only. Limit: 1/rule. MANDATORY: module ({api_name: 'Leads'\|'Contacts'}), field_mappings (exactly 1 entry with field + value for owner assignment). value.type: 'user'\|'role'\|'group'\|'country'. Errors: no_data if empty, too_many_records if >1. Additional keys: not allowed
`field_mappings`	array	Required within parent	REQUIRED. Exactly 1 field mapping entry. More than 1 returns too_many_records, none returns no_data. Maximum items: 1 Minimum items: 1
`field_mappings[]`	object	Each item	A field-to-value mapping entry for email-based record creation. Additional keys: not allowed
`field_mappings[].field`	object	Required within parent	Field reference. Use GET /settings/fields?module={api_name} to discover. Additional keys: not allowed
`field_mappings[].field.api_name`	string	Optional	Field API name. Maximum length: 255
`field_mappings[].field.id`	string	Optional	Field ID. Format: int64
`field_mappings[].value`	object	Required within parent	Owner assignment details. Additional keys: not allowed
`field_mappings[].value.resource`	object	Optional	Assignment target reference. Additional keys: not allowed
`field_mappings[].value.resource.id`	string	Optional	Resource ID. Format: int64
`field_mappings[].value.type`	string	Required within parent	Owner assignment type. Known values: user, role, group, country
`id`	string	Optional	Read-only. Unique identifier for the action. Maximum length: 20
`module`	object	Required within parent	REQUIRED. Target module - only 'Leads' or 'Contacts' allowed. Additional keys: not allowed
`module.api_name`	string	Required within parent	Module API name. Must be 'Leads' or 'Contacts'. Known values: Leads, Contacts

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents an associate action that sends a pre-configured email notification 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 email notification. 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 email notification. Required when associating an existing email notification with the rule. Maximum length: 20
`name`	string	Optional	Represents the display name of the EmailNotificationAssociate action. Returned in GET responses and derived from the associated 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 email notifications related details Controls whether the email is sent at the best time for the recipient (powered by Data Intelligence). Null when best_time is not enabled.
`type`	string	Required within parent	Represents the action type discriminator that identifies this as a EmailNotificationAssociate 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: email_notifications

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 related details, 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 email notifications related details

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Represents the optional related configuration details for email notification actions, including best-time delivery settings.
`$ (anyOf 1)`	object	Alternative	Represents the best-time delivery configuration for the email notification action, controlling when the email sends to reach the recipient at the optimal delivery time. Additional keys: not allowed
`$ (anyOf 1).best_time`	boolean	Optional	Indicates whether to send the email notification at the best time for the recipient. When set to true, the platform determines the optimal send time.
`$ (anyOf 2)`	null	Alternative	Represents a null value indicating best-time delivery is not configured for this email notification action.

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents an associate action that updates field values using a pre-configured field update action 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 field update 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 field update action. Use the Get Field Updates API to retrieve available IDs. Maximum length: 20
`name`	string	Optional	Represents the display name of the FieldUpdateAssociate 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 field updates related details Specifies the lookup field when the field update targets a related module. Null when the update targets the workflow rule's own module.
`type`	string	Required within parent	Represents the action type discriminator that identifies this as a FieldUpdateAssociate 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: field_updates

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type field updates related details, 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 field updates related details

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Represents the optional related configuration details for field update actions, specifying the lookup field used for cross-module field updates.
`$ (anyOf 1)`	object	Alternative	Represents the lookup field configuration that identifies the related module record for cross-module field update actions. Additional keys: not allowed
`$ (anyOf 1).lookup_field`	Model	Optional	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module The lookup field linking the rule module to the target module (e.g., Account_Name on Contacts). Provide the field's id and api_name.
`$ (anyOf 2)`	null	Alternative	Represents a null value indicating the field update targets the workflow rule own module with no lookup field required.

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 flow

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that triggers a Zoho Flow workflow when the workflow rule condition is met. Additional keys: not allowed
`_delete`	null	Optional	Indicates that this Zoho Flow action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
`details`	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 flow details Configuration for the Zoho Flow action. Requires the ID and name of the custom action to trigger in Zoho Flow.
`id`	string	Optional	Represents the unique ID of the Zoho Flow action within the workflow rule. Maximum length: 20
`name`	string	Required within parent	Represents the display name of the Zoho Flow action. This field is required. Maximum length: 100
`type`	string	Required within parent	Represents the action type discriminator that identifies this as a Zoho Flow action within the workflow rule. Must equal: flow

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Details object for flow action. Triggers a Zoho Flow custom action. Limit: 1/rule. Fetch values from `getCustomActions` (filter service_type='zoho_flow', component_type='workflow'): use response `id` as custom_action_id, `action_name` as custom_action_name. MANDATORY: custom_action_id (string), custom_action_name (string). EXAMPLE: {"custom_action_id": "4839491000001566002", "custom_action_name": "Sync to ERP"} Additional keys: not allowed
`custom_action_id`	string	Required within parent	REQUIRED. Zoho Flow custom action ID. Value = `id` from `getCustomActions` response. Format: int64
`custom_action_name`	string	Required within parent	REQUIRED. Display name of the Zoho Flow action. Value = `action_name` from `getCustomActions` response. Maximum length: 255
`id`	string	Optional	Read-only. Unique identifier for the action. Maximum length: 20

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that removes one or more tags from the triggering record when the workflow rule condition is met. 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`	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 remove tags details Configuration for remove_tags actions. The tags array is required and must contain between 1 and 10 entries, each specifying both the tag identifier and name. Tags must already exist in the system before they can be removed. The module reference is optional but when provided, its API name and identifier must match the trigger module. The over_write field is accepted for type compatibility but its value is ignored for remove_tags operations. This action is invalid when the same rule contains an add_tags action with over_write set to true. It cannot be used alongside a convert action on Leads modules, as this combination triggers an AMBIGUITY_DURING_PROCESSING error. The remove_tags action is not supported for Visits, Users, or LinkingModules. Example configuration: {"tags": [{"id": "111111000000050001", "name": "Hot Lead"}], "module": {"api_name": "Leads", "id": "111111000000000175"}}
`id`	string	Optional	Represents the unique ID of the RemoveTags action within the workflow rule. Maximum length: 20
`name`	string	Optional	Represents the display name of the RemoveTags action as it appears within the workflow rule configuration. Maximum length: 100
`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 convert related details Optional. For remove_tags, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only).
`type`	string	Required within parent	Represents the action type discriminator that identifies this as a RemoveTags 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: remove_tags

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	PURPOSE: Details object for remove_tags action. Removes tags from the triggering record. PREREQUISITES: Tags must exist - GET /settings/tags?module={api_name} to list. MANDATORY: tags (array 1-10, each {id, name}). OPTIONAL: module ({api_name, id}). CONSTRAINTS: Not allowed with convert on Leads (AMBIGUITY_DURING_PROCESSING). If same rule has add_tags with over_write=true, this returns INVALID_DATA. Unsupported: Visits, Users, LinkingModules (NOT_ALLOWED). Note: over_write field is type-checked but its value is ignored for remove_tags. Additional keys: not allowed
`id`	string	Optional	Server-generated unique identifier for this remove tags action. Present only in GET responses; not required in POST or PUT requests. Maximum length: 20
`module`	Model	Optional	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call details module Target module for the tag action. Must match the workflow rule's trigger module. Supported modules: Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price_Books, Quotes, Sales_Orders, Purchase_Orders, Invoices, and custom modules. Unsupported modules (Visits, Users, LinkingModules) return NOT_ALLOWED.
`over_write`	boolean	Optional	Present in GET responses. Its value is ignored for remove_tags actions. Default: false
`tags`	array	Required within parent	List of tags to remove from the record. All tags must pre-exist in the org - fetch available tags from GET /settings/tags?module={module_api_name}. If the list is empty after parsing, the API returns FAILURE ('Empty Tag'). If the tag count exceeds the edition limit, the API returns FAILURE ('Invalid Tag Count'). Maximum items: 10 Minimum items: 1
`tags[]`	Model	Each item	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item instant actions actions item value type add tags details tags item Represents a tag reference, conforming to the AutomationTagRef schema, that identifies a pre-existing org tag to be removed from the record. Both id and name are mandatory fields on each entry; the referenced tag must already exist in the org before the action executes.

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a non-associate action that schedules a call activity on the triggering record when the workflow rule condition is met. 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`	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 schedule call details Configuration for the schedule_call action. Requires the Calls module, a layout, and field mappings that include the call subject. Optionally restricts creation to prevent duplicate records.
`id`	string	Optional	Represents the unique ID of the ScheduleCall action within the workflow rule. Maximum length: 20
`name`	string	Optional	Represents the display name of the ScheduleCall action as it appears within the workflow rule configuration. Maximum length: 100
`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 convert related details Optional. For schedule_call, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only).
`type`	string	Required within parent	Represents the action type discriminator that identifies this as a ScheduleCall 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: schedule_call

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

Report an issue with this page