Skip to content

Zoho: Workflow rules schemas (part 3)

31 Zoho schemas with complete fields and constraints.

← Workflow rules operations · All schemas

Update Workflow Rule by ID — request body — body workflow rules item

FieldTypePresenceDescription and constraints
$objectRootRepresents the configuration object for updating an existing workflow rule, including the rule ID and optional fields such as name, trigger, conditions, and lock status.
Additional keys: not allowed
conditionsarrayOptionalSpecify the array of condition objects to update. On update, unspecified conditions are preserved. Conditions with a null ID are added; conditions with an existing ID get replaced; conditions with a **_delete** flag are removed.
Maximum items: 20
conditions[]ModelEach itemExpand Update Workflow Rule by ID — request body — body workflow rules item conditions item
descriptionstringOptionalSpecify the workflow rule description.
Maximum length: 1000
execute_whenModelOptionalExpand Update Workflow Rule by ID — request body — body workflow rules item execute when
Defines the conditions under which the workflow rule will be executed. (Required)
idstringOptionalRepresents the unique ID of the workflow rule to update. Required.
Maximum length: 30
lockobjectOptionalSpecify whether the workflow rule should be locked to prevent editing by other users.
Additional keys: not allowed
lock.messagestringOptionalSpecify a note or label indicating the reason or context for locking the rule.
Format: string
lock.statusbooleanOptionalSpecify whether to lock or unlock the workflow rule.
Possible values:
true - Locks the rule to prevent editing.
false - Unlocks the rule.
One of: true, false
moduleModelOptionalExpand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module
namestringOptionalSpecify the workflow rule name. Required.
Maximum length: 100
statusobjectOptionalSpecify the activation state of the workflow rule. When setting **active** to false, you can optionally delete all associated scheduled actions.
Additional keys: not allowed
status.activebooleanOptionalSpecify whether the workflow rule is active or inactive.
Possible values:
true - The rule is active and executes when triggered.
false - The rule is inactive and does not execute.
status.delete_schedule_actionbooleanOptionalSpecify whether to delete all scheduled actions associated with the workflow rule when deactivating it.
Possible values:
true - Delete all scheduled actions when the rule is deactivated.
false - Preserve scheduled actions when the rule is deactivated.

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

Update Workflow Rule by ID — request body — body workflow rules item conditions item

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
_deletenullOptionalIndicates that this condition should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
criteria_detailsModelOptionalExpand Update Workflow Rule by ID — request body — 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.
idstringOptionalRepresents the unique ID of the condition. Auto-generated on creation. Required on PUT to identify which condition to update.
Format: int64
instant_actionsModelOptionalExpand Update Workflow Rule by ID — request body — 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_actionsModelOptionalExpand Update Workflow Rule by ID — request body — 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_numberintegerRequired within parentRepresents the execution order of this condition within the workflow rule, starting from one. Must be unique across all conditions in the rule.
Format: int32

Referenced models: Update Workflow Rule by ID — request body — body workflow rules item conditions item criteria details, Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions, Update Workflow Rule by ID — request body — body workflow rules item conditions item scheduled actions

Update Workflow Rule by ID — request body — body workflow rules item conditions item criteria details

FieldTypePresenceDescription and constraints
$objectRootRepresents the filter criteria that determine which records satisfy the workflow rule condition.
Additional keys: not allowed
criteriaJSONOptionalRepresents 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)ModelAlternativeExpand Related Records — request body — query filters value
criteria (anyOf 2)ModelAlternativeExpand Related Records — request body — query / filters / group_operator: AND, OR, and, or
criteria (anyOf 3)nullAlternativeRepresents a null variant indicating no criteria or module filter is applied.
relational_criteriaobjectOptionalRepresents 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.criteriaJSONOptionalRepresents the filter criteria applied to the related module records. Follows the same structure as the top-level criteria field.
relational_criteria.criteria (anyOf 1)ModelAlternativeExpand Related Records — request body — query filters value
relational_criteria.criteria (anyOf 2)ModelAlternativeExpand Related Records — request body — query / filters / group_operator: AND, OR, and, or
relational_criteria.criteria (anyOf 3)nullAlternativeRepresents a null variant indicating no criteria or module filter is applied.
relational_criteria.moduleJSONOptionalRepresents the related module to filter on. Required when **module_selection** is set to **specific**.
relational_criteria.module (anyOf 1)ModelAlternativeExpand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module
relational_criteria.module (anyOf 2)nullAlternativeRepresents a null variant indicating no criteria or module filter is applied.
relational_criteria.module_selectionstring or nullOptionalRepresents the scope selector for the related module filter. Required when **relational_criteria** is present.
One of: all, specific, unknown, null

Referenced models: Related Records — request body — query / filters / group_operator: AND, OR, and, or, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module, Related Records — request body — query filters value

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions

FieldTypePresenceDescription and constraints
$objectRootRepresents the container for instant actions that execute immediately when the workflow rule condition is met.
Additional keys: not allowed
actionsarrayRequired within parentRepresents 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[]JSONEach item
actions[] (anyOf 1)ModelAlternativeExpand Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value — Non Associate Actions Nested Schema
actions[] (anyOf 2)ModelAlternativeExpand Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value — Associate Actions Nested Schema

Referenced models: Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value — Associate Actions Nested Schema, Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value — Non Associate Actions Nested Schema

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value delete, details, id, name, type details

FieldTypePresenceDescription and constraints
$objectRootPURPOSE: 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
idstringOptionalRead-only. Unique identifier for the action, returned in GET responses.
Maximum length: 20
messagestringRequired within parentREQUIRED. 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_toobjectRequired within parentREQUIRED. Notification target - a channel, user, or field-based recipient.
Additional keys: not allowed
notify_to.idstringOptionalRequired for user/channel types. The integration-specific user or channel ID.
Maximum length: 255
notify_to.moduleobjectOptionalRequired 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_namestringOptionalModule API name.
Maximum length: 255
notify_to.module.idstringOptionalModule ID.
Format: int64
notify_to.namestringOptionalRequired for user/channel types. Display name of the user or channel (e.g., '#sales-alerts').
Maximum length: 255
notify_to.notify_fieldsModelOptionalExpand 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.typestringRequired within parentTarget type. 'user' - send to a specific chat user. 'channel' - send to a chat channel. 'fields' - send to users resolved from CRM field values.
One of: 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

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value delete, details, id, name, type — Chat Notification Action Schema

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
_deletenullOptionalIndicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
detailsModelRequired within parentExpand Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value delete, details, id, name, type details
Configuration for the chat notification action. Requires a message, which supports merge fields, and a target channel, user, or field to notify.
idstringOptionalRepresents the unique ID of the ChatNotification action within the workflow rule.
Maximum length: 20
namestringRequired within parentRepresents the display name of the ChatNotification action. This field is required.
Maximum length: 100
typestringRequired within parentRepresents chat service type. Each service has a limit of 1 action per rule.
One of: slack_notifications, cliq_notifications, cisco_notifications, google_chat_notifications, microsoft_teams_notifications

Referenced models: Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value delete, details, id, name, type details

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value delete, details, id, name, type — Social Action Schema

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
_deletenullOptionalIndicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
detailsModelOptionalExpand 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.
idstringOptionalRepresents the unique ID of the Social action within the workflow rule.
Maximum length: 20
namestringOptionalRepresents the display name of the Social action as it appears within the workflow rule configuration.
Maximum length: 100
typestringRequired within parentRepresents the social action type. Facebook actions require Facebook-specific triggers, and Twitter actions require Twitter-specific triggers.
One of: comment_to_post, reply_to_comment, like_to_comment, reply_to_message, retweet, reply_to_tweet

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

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type add meeting

FieldTypePresenceDescription and constraints
$objectRootRepresents a non-associate action that schedules a meeting when the workflow rule condition is triggered.
Additional keys: not allowed
_deletenullOptionalIndicates 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.
detailsModelRequired within parentExpand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting
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.
idstringOptionalRepresents the unique ID of the add-meeting action within the workflow rule.
Maximum length: 20
namestringOptionalRepresents the display name of the add-meeting action as it appears within the workflow rule configuration.
Maximum length: 100
related_detailsModelOptionalExpand Update Workflow Rule by ID — request body — 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).
typestringRequired within parentRepresents 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: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting, Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type convert related details

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type add tags

FieldTypePresenceDescription and constraints
$objectRootRepresents a non-associate action that adds pre-existing tags to the triggering record when the workflow rule condition is met.
Additional keys: not allowed
_deletenullOptionalIndicates 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.
detailsModelRequired within parentExpand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags
idstringOptionalRepresents the unique ID of the add-tags action within the workflow rule.
Maximum length: 20
namestringOptionalRepresents the display name of the add-tags action as it appears within the workflow rule configuration.
Maximum length: 100
related_detailsModelOptionalExpand Update Workflow Rule by ID — request body — 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).
typestringRequired within parentRepresents 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: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags, Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type convert related details

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type assign owner

FieldTypePresenceDescription and constraints
$objectRootRepresents a non-associate action that assigns or reassigns the record owner when the workflow rule condition is triggered.
Additional keys: not allowed
_deletenullOptionalIndicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
detailsModelRequired within parentExpand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner
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.
idstringOptionalRepresents the unique ID of the AssignOwner action within the workflow rule.
Maximum length: 20
namestringOptionalRepresents the display name of the AssignOwner action as it appears within the workflow rule configuration.
Maximum length: 100
related_detailsModelOptionalExpand Update Workflow Rule by ID — request body — 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).
typestringRequired within parentRepresents 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

Referenced models: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner, Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type convert related details

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type convert

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
_deletenullOptionalIndicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
detailsModelRequired within parentExpand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert
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.
idstringOptionalRepresents the unique ID of the Convert action within the workflow rule.
Maximum length: 20
namestringOptionalRepresents the display name of the Convert action as it appears within the workflow rule configuration.
Maximum length: 100
related_detailsModelOptionalExpand Update Workflow Rule by ID — request body — 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).
typestringRequired within parentRepresents 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: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert, Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type convert related details

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type convert related details

FieldTypePresenceDescription and constraints
$JSONRootRepresents 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)objectAlternativeRepresents the email notification related details, including best-time delivery configuration.
Additional keys: not allowed
$ (anyOf 1).best_timebooleanOptionalIndicates 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)objectAlternativeRepresents the task related details, including followup task configuration.
Additional keys: not allowed
$ (anyOf 2).followup_detailsModelOptionalExpand Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type tasks related details followup details followup details
$ (anyOf 3)objectAlternativeRepresents the field update related details, including the lookup field for cross-module updates.
Additional keys: not allowed
$ (anyOf 3).lookup_fieldModelOptionalExpand 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)nullAlternativeRepresents 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, Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type tasks related details followup details followup details

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type create connected record

FieldTypePresenceDescription and constraints
$objectRootRepresents a non-associate action that creates a connected record in a child module when the workflow rule condition is triggered.
Additional keys: not allowed
_deletenullOptionalIndicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
detailsModelRequired within parentExpand Update Workflow Rule by ID — request body — 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.
idstringOptionalRepresents the unique ID of the CreateConnectedRecord action within the workflow rule.
Maximum length: 20
namestringOptionalRepresents the display name of the CreateConnectedRecord action as it appears within the workflow rule configuration.
Maximum length: 100
related_detailsModelOptionalExpand Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type convert related details
Optional. Not typically used for create_connected_record.
typestringRequired within parentRepresents 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: Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type create connected record details, Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type convert related details

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type create connected record details

FieldTypePresenceDescription and constraints
$objectRootPURPOSE: 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_restrictionbooleanOptionalApply assignment/workflow restrictions. Default true.
field_mappingsarrayRequired within parentREQUIRED. 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[]ModelEach itemExpand Create an Automation Task — request body — body 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.
idstringOptionalRead-only. Unique identifier for the action.
Maximum length: 20
layoutModelRequired within parentExpand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting 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}.
moduleobjectRequired within parentREQUIRED. 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_namestringRequired within parentModule API name.
Maximum length: 255
module.idstringOptionalModule ID.
Format: int64

Referenced models: Create an Automation Task — request body — body tasks item field mappings item, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting layout

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type create record

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
_deletenullOptionalIndicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
detailsModelRequired within parentExpand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks create record
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.
idstringOptionalRepresents the unique ID of the CreateRecord action within the workflow rule.
Maximum length: 20
namestringOptionalRepresents the display name of the CreateRecord action as it appears within the workflow rule configuration.
Maximum length: 100
related_detailsModelOptionalExpand Update Workflow Rule by ID — request body — 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).
typestringRequired within parentRepresents 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: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks create record, Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type convert related details

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type create record email

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
_deletenullOptionalIndicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
detailsModelRequired within parentExpand Update Workflow Rule by ID — request body — 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.
idstringOptionalRepresents the unique ID of the EmailCreateRecord action within the workflow rule.
Maximum length: 20
namestringOptionalRepresents the display name of the EmailCreateRecord action as it appears within the workflow rule configuration.
Maximum length: 100
typestringRequired within parentRepresents 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: Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type create record email details

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type create record email details

FieldTypePresenceDescription and constraints
$objectRootPURPOSE: 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_mappingsarrayRequired within parentREQUIRED. Exactly 1 field mapping entry. More than 1 returns too_many_records, none returns no_data.
Maximum items: 1
Minimum items: 1
field_mappings[]objectEach itemA field-to-value mapping entry for email-based record creation.
Additional keys: not allowed
field_mappings[].fieldobjectRequired within parentField reference. Use GET /settings/fields?module={api_name} to discover.
Additional keys: not allowed
field_mappings[].field.api_namestringOptionalField API name.
Maximum length: 255
field_mappings[].field.idstringOptionalField ID.
Format: int64
field_mappings[].valueobjectRequired within parentOwner assignment details.
Additional keys: not allowed
field_mappings[].value.resourceobjectOptionalAssignment target reference.
Additional keys: not allowed
field_mappings[].value.resource.idstringOptionalResource ID.
Format: int64
field_mappings[].value.typestringRequired within parentOwner assignment type.
One of: user, role, group, country
idstringOptionalRead-only. Unique identifier for the action.
Maximum length: 20
moduleobjectRequired within parentREQUIRED. Target module - only 'Leads' or 'Contacts' allowed.
Additional keys: not allowed
module.api_namestringRequired within parentModule API name. Must be 'Leads' or 'Contacts'.
One of: Leads, Contacts

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type remove tags

FieldTypePresenceDescription and constraints
$objectRootRepresents 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
_deletenullOptionalIndicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
detailsModelRequired within parentExpand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks remove tags
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"}}
idstringOptionalRepresents the unique ID of the RemoveTags action within the workflow rule.
Maximum length: 20
namestringOptionalRepresents the display name of the RemoveTags action as it appears within the workflow rule configuration.
Maximum length: 100
related_detailsModelOptionalExpand Update Workflow Rule by ID — request body — 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).
typestringRequired within parentRepresents 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: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks remove tags, Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type convert related details

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type schedule call

FieldTypePresenceDescription and constraints
$objectRootRepresents a non-associate action that schedules a call activity on the triggering record when the workflow rule condition is met.
Additional keys: not allowed
_deletenullOptionalIndicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.
detailsModelRequired within parentExpand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks schedule call
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.
idstringOptionalRepresents the unique ID of the ScheduleCall action within the workflow rule.
Maximum length: 20
namestringOptionalRepresents the display name of the ScheduleCall action as it appears within the workflow rule configuration.
Maximum length: 100
related_detailsModelOptionalExpand Update Workflow Rule by ID — request body — 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).
typestringRequired within parentRepresents 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: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks schedule call, Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type convert related details

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type tasks

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

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

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type tasks related details

FieldTypePresenceDescription and constraints
$JSONRootRepresents the optional related configuration details for task actions, specifying whether and how a followup task should be created.
$ (anyOf 1)objectAlternativeRepresents the followup task configuration that defines the status condition and delay for automatically creating a followup task.
Additional keys: not allowed
$ (anyOf 1).followup_detailsModelOptionalExpand Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type tasks related details followup details followup details
$ (anyOf 2)nullAlternativeRepresents a null value indicating no followup task is configured for this task action.

Referenced models: Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type tasks related details followup details followup details

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value type tasks related details followup details followup details

FieldTypePresenceDescription and constraints
$objectRootRepresents the followup task configuration, including the trigger condition and delay settings.
Additional keys: not allowed
conditionstringOptionalRepresents the task status condition that triggers the followup task, such as **Completed** or **Not Started**.
Maximum length: 255
periodstringOptionalRepresents the time period label for the delay before creating the followup task, such as **days**, **hours**, or **minutes**.
Maximum length: 50
unitintegerOptionalRepresents the numeric time value for the delay before creating the followup task.
Format: int32

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value — Associate Actions Nested Schema

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

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

Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value — Non Associate Actions Nested Schema

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

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

Update Workflow Rule by ID — request body — body workflow rules item conditions item scheduled actions

FieldTypePresenceDescription and constraints
$array or nullRootRepresents the container for scheduled actions that execute after a configured delay from the time the workflow rule condition is triggered.
Maximum items: 5
$[]object or nullEach itemSpecify when the scheduled actions should be executed
Additional keys: not allowed
$[].actionsarrayRequired within parentRepresents the array of action objects for this scheduled group. Uses the same associate and non-associate action structure as instant actions, but only action types that support scheduled execution are allowed. Per-type limits apply independently to instant and scheduled actions.

Maximum items: 50
$[].actions[]JSONEach item
$[].actions[] (anyOf 1)ModelAlternativeExpand Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value — Non Associate Actions Nested Schema
$[].actions[] (anyOf 2)ModelAlternativeExpand Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value — Associate Actions Nested Schema
$[].execute_afterobjectOptionalDefines the delay before the scheduled actions execute. Required. Cannot be an empty object.
Additional keys: not allowed
$[].execute_after.periodstringRequired within parentRepresents the type of time interval. Required. Must be one of the allowed period values (invalid_schedule_actions_period if invalid). business_hours and business_days are only available when org business hours are configured. The API returns available periods from getWorkflowConfigurations.
One of: minutes, hours, days, weeks, months, years, business_hours, business_days
$[].execute_after.unitintegerRequired within parentRepresents the numeric delay value. Required. Allowed ranges per period (unit_not_allowed_for_period if out of range): minutes: 5-180 (2-180 if 1-min repetition feature is enabled), hours: 0-99, days: 0-2000, weeks: 0-100, months: 0-24, years: 0-10, business_hours: 0-99, business_days: 0-2000. All values must be non-negative (no pre-event offsets for scheduled actions).
Format: int32
$[].idstringOptionalRepresents unique Id of the scheduled action
Maximum length: 20

Referenced models: Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value — Associate Actions Nested Schema, Update Workflow Rule by ID — request body — body workflow rules item conditions item instant actions actions item value — Non Associate Actions Nested Schema

Update Workflow Rule by ID — request body — body workflow rules item execute when

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

Referenced models: Update Workflow Rule by ID — request body — body workflow rules item execute when details, type — Execute When T1 Simple, Update Workflow Rule by ID — request body — body workflow rules item execute when details, type — Execute When T2 Field Update, Update Workflow Rule by ID — request body — body workflow rules item execute when details, type — Execute When T3 Section Update, Update Workflow Rule by ID — request body — body / workflow_rules / item / execute_when / type: date or datetime, Update Workflow Rule by ID — request body — body workflow rules item execute when details, type — Execute When T5 Time Offset, Update Workflow Rule by ID — request body — body / workflow_rules / item / execute_when / type: score increase, score decrease, score update, zia scoring rule, Update Workflow Rule by ID — request body — body / workflow_rules / item / execute_when / type: mail sent replied within

Update Workflow Rule by ID — request body — body workflow rules item execute when details, type — Execute When T1 Simple

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

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

Update Workflow Rule by ID — request body — body workflow rules item execute when details, type — Execute When T2 Field Update

FieldTypePresenceDescription and constraints
$objectRootRepresents a field update trigger type that fires when a specified field value on a record changes according to defined criteria.
Additional keys: not allowed
detailsobjectRequired within parentRepresents the field update trigger details, including the criteria that define which field value change activates the rule.
Additional keys: not allowed
details.criteriaJSONRequired within parentRepresents the field value change criteria that activate the trigger. Defines which field is monitored and what change condition fires the rule.
details.criteria (anyOf 1)ModelAlternativeExpand Update Workflow Rule by ID — request body — body / workflow_rules / item / execute_when / details, type / details / criteria / type: merge field, pre defined, value, field
details.criteria (anyOf 2)ModelAlternativeExpand Update Workflow Rule by ID — request body — body / workflow_rules / item / execute_when / details, type / details / criteria / group_operator: AND, OR
details.match_allbooleanOptionalControls the logic applied across criteria groups.
Possible values:
true - All criteria groups must match (AND logic).
false - Any one criteria group is sufficient (OR logic).
details.repeatbooleanOptionalIndicates whether the rule fires every time the field update condition is met. When false, the rule fires only on the first occurrence.
details.trigger_moduleModelOptionalExpand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module
The module that actually triggers the rule. Defaults to the rule's top-level module if omitted. Must be explicitly set when the trigger targets a different module - e.g., a rule on Leads triggered by 'note created' requires trigger_module = {api_name: 'Notes', id: '...'}. Use `getModules` to discover module api_name and id values.
typestringRequired within parentRepresents the trigger type for field update rules. Availability varies by the target module.
One of: field_update, incoming_call_field_update, outgoing_call_field_update, scheduled_call_field_update, stage_automation_field_update, rollup_summary_update

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

Update Workflow Rule by ID — request body — body workflow rules item execute when details, type — Execute When T3 Section Update

FieldTypePresenceDescription and constraints
$objectRootRepresents the trigger type for section update rules. Availability varies by the target module

Additional keys: not allowed
detailsModelRequired within parentExpand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when details, type details — shared_details_be3cf6ec2c47
typestringRequired within parentRepresents the trigger type for section update rules. Use getWorkflowConfigurations to verify the trigger is available for the target module.
One of: section_update, incoming_call_section_update, outgoing_call_section_update, scheduled_call_section_update

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

Update Workflow Rule by ID — request body — body workflow rules item execute when details, type — Execute When T5 Time Offset

FieldTypePresenceDescription and constraints
$objectRootRepresents the trigger type for time-offset rules. Availability varies by the target module.

Additional keys: not allowed
detailsobjectRequired within parentRepresents the time offset trigger details, including the time unit and magnitude for the offset.
Additional keys: not allowed
details.fieldobjectOptionalRepresents the field reference returned in GET responses for time-offset triggers, including the trigger field details.
Additional keys: not allowed
details.field.idstringOptionalRepresents the field identifier for the time-offset trigger. Returns **-1** when the field is system-determined.
Maximum length: 20
details.periodstringRequired within parentRepresents the time unit for the offset.
Possible values:
days - Offset in days.
hours - Offset in hours.
One of: days, hours
details.trigger_moduleModelOptionalExpand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module
The module that actually triggers the rule. Defaults to
the rule's top-level module if omitted. Must be explicitly set
when the trigger targets a different module - e.g., a rule on
Leads triggered by 'note created' requires trigger_module =
{api_name: 'Notes', id: '...'}. Use `getModules` to discover
module api_name and id values.
details.unitintegerRequired within parentRepresents the time offset magnitude. Always a positive integer for time-offset triggers, such as 1 for one day or 3 for three hours.
Format: int32
typestringRequired within parentRepresents the trigger type for time-offset rules. Use getWorkflowConfigurations to verify the trigger is available for the target module.
One of: overdue, email_received_notreplied, email_received_opened_notreplied, mail_sent_opened_notreplied, mail_sent_notreplied, mail_sent_notopened, recommendation_rebuy

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

Update Workflow Rule by ID — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the success response returned after creating a workflow rule, containing the result details of the created rule.
Additional keys: not allowed
workflow_rulesarrayOptionalRepresents the array of workflow rule objects returned in the success response.
Maximum items: 200
workflow_rules[]ModelEach itemExpand Update Workflow Rule Execution Order for Module — response body — reorder item

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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.