Zoho: Workflow configurations schemas
6 Zoho schemas with complete fields and constraints.
← Workflow configurations operations · All schemas
Workflow Configuration — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing workflow configurations for a module including available triggers, actions, and related trigger details. Additional keys: not allowed |
workflow_configurations | Model | Optional | Expand Workflow Configuration — response body — workflow configurations Workflow configuration metadata for the requested module. |
Referenced models: Workflow Configuration — response body — workflow configurations
Workflow Configuration — response body — workflow configurations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Configuration metadata for workflows on a specific module. Contains three sections: triggers (events that fire the rule), actions (operations available when the rule fires with their per-type limits and scheduling support), and related_triggers_details (child/related modules like Notes or Calls whose events can also trigger rules on the parent module). Additional keys: not allowed |
actions | array | Optional | List of available action types for the module. Each action defines an operation that can be performed when the workflow rule fires, along with its per-type limit (applies independently to instant_actions and scheduled_actions), scheduling support, and whether it is an associate action (reusable entity referenced by ID) or non-associate action (defined inline). Maximum items: 20 |
actions[] | Model | Each item | Expand Workflow Configuration — response body — workflow configurations actions item |
related_triggers_details | array | Optional | List of related modules (e.g., Notes, Calls, Activities) whose record events can trigger workflow rules on the parent module. Each entry contains the related module's identity and available trigger types. Maximum items: 20 |
related_triggers_details[] | Model | Each item | Expand Workflow Configuration — response body — workflow configurations related triggers details item |
triggers | array | Optional | Represents the list of trigger types available for the module. Each entry defines an event that can initiate a workflow rule, along with the action types supported for that trigger (for example, create, edit, delete, field_update, date_or_datetime). Maximum items: 20 |
triggers[] | Model | Each item | Expand Workflow Configuration — response body — workflow configurations triggers item |
Referenced models: Workflow Configuration — response body — workflow configurations actions item, Workflow Configuration — response body — workflow configurations related triggers details item, Workflow Configuration — response body — workflow configurations triggers item
Workflow Configuration — response body — workflow configurations actions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an action type available for the module. Defines an operation that can be performed when a workflow rule triggers. The limit field is the per-type cap that applies independently to instant_actions and scheduled_actions - for instance, if limit=5, you can add up to 5 instances in instant_actions and up to 5 in scheduled_actions of the same rule. Additional keys: not allowed |
api_name | string | Optional | Represents the API identifier of the action type used when creating or modifying workflow rules (for example, field_updates, email_notifications, webhooks, assign_owner, add_tags, remove_tags, create_record, add_meeting, schedule_call, convert, functions, flow). Maximum length: 255 |
associate_action | boolean | Optional | Indicates whether this action type is an associate action. Associate actions link or associate records between modules (for example, linking a Contact to a Deal or associating a Product with an Order). Associate actions differ from standard data-write actions such as field_updates or email_notifications. Possible values: **true** - This action type is an associate action. **false** - This action type is a standard non-associate action. |
is_clickable | boolean | Optional | Indicates whether this action type can be edited directly from the workflow configuration UI page. Not relevant for API usage. |
limit | JSON | Optional | |
limit (anyOf 1) | integer | Alternative | Maximum number of instances of this action type allowed per workflow rule. Applies independently to instant_actions and scheduled_actions - for instance, if limit=5, you can add up to 5 instances in instant_actions and up to 5 in scheduled_actions. Returns LIMIT_EXCEEDED if exceeded. Format: int32 Minimum: 1 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
limit_per_action | JSON | Optional | |
limit_per_action (anyOf 1) | JSON | Alternative | |
limit_per_action (anyOf 1) (anyOf 1) | integer | Alternative | Represents the maximum number of items within a single action instance. For example, add_tags and remove_tags allow a maximum of 10 tags per action. Returns null if no per-action item limit applies. Format: int32 |
limit_per_action (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
limit_per_action (anyOf 2) | null | Alternative | Represents the maximum number of items within a single action instance. For example, add_tags and remove_tags allow a maximum of 10 tags per action. Returns null if no per-action item limit applies. Format: int32 |
name | string | Optional | Represents the display name of the action type as shown in the CRM UI. Maximum length: 255 |
supported_in_scheduled_action | boolean | Optional | Indicates whether this action type can be used as a scheduled (time-delayed) action in a workflow rule. **Possible values:** true - This action type is supported in scheduled_actions (for example, time-delayed email_notifications or field_updates). false - This action type is only supported in instant_actions. |
Workflow Configuration — response body — workflow configurations related triggers details item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a related module that can act as a trigger source for the parent module's workflow rules. For example, when a user creates a Note on a Lead record, a workflow rule on the Leads module configured with a Notes-related trigger fires. Additional keys: not allowed |
api_name | string | Optional | Represents the API name of the related module that can act as a trigger source (for example, Notes, Tasks, Events, Attachments). Use this value to identify the related module when creating workflow rules that should fire on related record events. Maximum length: 255 |
module | Model | Optional | Expand Workflow Configuration — response body — workflow configurations related triggers details item module Module identity including api_name, id, and labels. |
name | string | Optional | Represents the display name of the related module. Maximum length: 255 |
triggers | array | Optional | Represents the list of trigger types available from this related module. These triggers can be used in workflow rules on the parent module via the execute_when.details.trigger_module field. Maximum items: 20 |
triggers[] | Model | Each item | Expand Workflow Configuration — response body — workflow configurations triggers item |
Referenced models: Workflow Configuration — response body — workflow configurations related triggers details item module, Workflow Configuration — response body — workflow configurations triggers item
Workflow Configuration — response body — workflow configurations related triggers details item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a CRM module with its identity and display labels, including its API name, singular and plural display labels, unique ID, and internal name. Additional keys: not allowed |
api_name | string | Optional | Represents the API name of the CRM module used in API requests (for example, Leads, Contacts, Deals, Accounts, Tasks, Cases, Products, Quotes, Sales_Orders, Invoices, Campaigns, Vendors). Maximum length: 255 |
id | string | Optional | Represents the unique identifier of the CRM module. Maximum length: 20 |
name | string | Optional | Represents the internal name of the CRM module. Maximum length: 255 |
plural_label | string | Optional | Represents the plural display name of the module as shown in the CRM UI (for example, Leads, Contacts, Deals). Maximum length: 255 |
singular_label | string | Optional | Represents the singular display name of the module as shown in the CRM UI (for example, Lead, Contact, Deal). Maximum length: 255 |
Workflow Configuration — response body — workflow configurations triggers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A trigger type available for the module. Defines the event that initiates a workflow rule. Use the api_name value in the execute_when.type field when creating or updating a workflow rule via POST/PUT /settings/automation/workflow_rules. Additional keys: not allowed |
actions | array | Optional | Represents the list of action type API names supported by this trigger. Only these action types can be used in workflow rules with this trigger type. Cross-reference with the top-level actions array in the response for full action metadata, including per-type limits and scheduling support. Maximum items: 20 |
actions[] | string | Each item | Represents an action type API name supported by this trigger (for example, field_updates, email_notifications, webhooks, assign_owner, add_tags, remove_tags, create_record, add_meeting, schedule_call, convert, functions, flow). Maximum length: 255 |
api_name | string | Optional | Represents the API identifier of the trigger type. Use this value in the execute_when.type field when creating a workflow rule (for example, create, edit, create_or_edit, delete, field_update, section_update, date_or_datetime, score_increase, score_decrease, score_update). Maximum length: 255 |
component_id | JSON | Optional | |
component_id (anyOf 1) | string | Alternative | Represents the component identifier for marketplace or custom triggers. Returns null for standard built-in trigger types. Maximum length: 255 |
component_id (anyOf 2) | null | Alternative | Represents the component identifier for marketplace or custom triggers. Returns null for standard built-in trigger types. Maximum length: 255 |
deprecated | boolean | Optional | Indicates whether this trigger type is deprecated. Possible values: true - The trigger type is deprecated and should not be used for new workflow rules, though it may still appear on existing rules. false - The trigger type is active and available for use. |
generated_type | JSON | Optional | |
generated_type (anyOf 1) | string | Alternative | Represents the generated type identifier for marketplace or custom triggers. Returns null for standard built-in trigger types. Maximum length: 255 |
generated_type (anyOf 2) | null | Alternative | Represents the generated type identifier for marketplace or custom triggers. Returns null for standard built-in trigger types. Maximum length: 255 |
name | string | Optional | Represents the display name of the trigger type as shown in the CRM UI (for example, Create, Edit, FieldUpdate, DateBased). Maximum length: 255 |
scheduled_actions_supported | boolean | Optional | Indicates whether this trigger type supports scheduled (time-delayed) actions. Possible values: true - Both instant_actions and scheduled_actions are available for workflow rules with this trigger. false - Only instant_actions can be used in workflow rules with this trigger. |