Zoho: Workflow tasks schemas

← Workflow tasks operations · All schemas

Automation Task — workflow Tasks delete Task By Id — response body

Field	Type	Presence	Description and constraints
$	object	Root	Single-task delete success response. Additional keys: not allowed
tasks	array	Required within parent	Contains one success result object for the deleted task. Maximum items: 1 Minimum items: 1
tasks[]	Model	Each item	Expand Create an Automation Task — response body — tasks item

Referenced models: Create an Automation Task — response body — tasks item

Automation Task — workflow Tasks get Task By Id — response body — tasks

Field	Type	Presence	Description and constraints
$	object	Root	Success response for retrieving a single automation task by ID. Contains the full task configuration including field_mappings, module, lock_status, and metadata. Additional keys: not allowed
tasks	array	Required within parent	Array containing exactly one task object matching the requested ID. Maximum items: 1
tasks[]	Model	Each item	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item

Referenced models: Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item

Field	Type	Presence	Description and constraints
$	object	Root	Automation task details returned by the API, including ownership, module context, and field mappings. Additional keys: not allowed
associated	boolean	Optional	Whether this task is associated with workflow/Blueprint/approval configuration.
created_by	Model	Optional	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item created by
created_time	string	Required within parent	Timestamp when the automation task was created. Maximum length: 255
deletable	boolean	Optional	Indicates whether this task can be deleted.
editable	boolean	Optional	Indicates whether this task can be edited by the current user/context.
feature_type	string	Required within parent	Specify the automation feature category that uses this task. Values: "workflow" (workflow rule), "approval_process" (Approval Process), "Blueprint" (Blueprint transition), "kiosks" (kiosk/process flow), "scoring_rule" (Scoring Rule), "case_escalation_rule" (case escalation rule). Known values: workflow, approval_process, blueprint, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, kiosks, pathfinder, connected_workflows, commandcenter_service, cadences, scoring_rule, case_escalation_rule Maximum length: 255
field_mappings	array	Required within parent	Specify the field mappings configured for the task. When an automation task is created, the fields should be mapped to tasks modules. Use this JSON array to map the fields of Automation Tasks fields to create tasks automatically when an automation is triggered. Maximum items: 20
field_mappings[]	Model	Each item	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item
id	string	Required within parent	Unique ID of the automation task. Maximum length: 255
lock_status	Model	Optional	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item lock status
modified_by	Model	Optional	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item modified by
modified_time	string	Required within parent	Timestamp when the task definition was last modified. Maximum length: 255
module	Model	Required within parent	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item module
name	string	Required within parent	Specify the name of the automation task. Maximum length: 255
notify	boolean	Optional	Whether owner notification is enabled for this task.
related_module	JSON	Optional	Related module metadata when the task is tied to a secondary module; otherwise null. Specify the api_name and id of the related module.
related_module (anyOf 1)	Model	Alternative	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item module
related_module (anyOf 2)	null	Alternative	Null when no related module is associated with the task.
source	string	Optional	Source system that created or owns this task (for example: crm). Maximum length: 255

Referenced models: Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item created by, Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item modified by, Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item, Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item lock status, Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item module

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item created by

Field	Type	Presence	Description and constraints
$	object	Root	Provides details about the creator of an entity, including their name and ID. Additional keys: not allowed
id	string	Optional	Unique Zoho CRM user ID of the creator. Maximum length: 255
name	string	Optional	Display name of the user who created this resource. Maximum length: 255

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents a single field-to-value mapping used within automation actions such as workflow tasks, create_record, add_meeting, and schedule_call. Each mapping identifies a target field via api_name or ID, declares a type discriminator that determines value interpretation, and supplies a value whose shape varies by type: static supplies a literal value, merge_field supplies a runtime-resolved token string, execution_time supplies a date or datetime offset object, and composite supplies structured participant data for the Events Participants field. The field_mappings array must include all fields the target module requires; omitting any produces a REQUIRED_DATA_NOT_FOUND error. discriminator: {"mapping": {"composite": "#/components/schemas/CompositeFieldMapping", "execution_time": "#/components/schemas/ExecutionTimeFieldMapping", "merge_field": "#/components/schemas/MergeFieldMapping", "static": "#/components/schemas/StaticFieldMapping"}, "propertyName": "type"}
$ (anyOf 1)	Model	Alternative	Expand Create an Automation Task — request body — body tasks item field mappings item type static
$ (anyOf 2)	Model	Alternative	Expand Create an Automation Task — request body — body tasks item field mappings item type merge field
$ (anyOf 3)	Model	Alternative	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item type execution time
$ (anyOf 4)	Model	Alternative	Expand Create an Automation Task — request body — body tasks item field mappings item type composite

Referenced models: Create an Automation Task — request body — body tasks item field mappings item type composite, Create an Automation Task — request body — body tasks item field mappings item type merge field, Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item type execution time, Create an Automation Task — request body — body tasks item field mappings item type static

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item type execution time

Field	Type	Presence	Description and constraints
$	object	Root	Represents an execution_time-type field mapping that computes a date, datetime, or ALARM value at runtime by applying a signed offset to a trigger field or the current time. The value carries an ExecutionTimeValue object specifying the period, unit, trigger_field, and optional time or notify_type properties. A plus sign places the result after the trigger; a minus sign places it before. ALARM fields always require minus. Workflow task actions support only days and business_days as period values. Additional keys: not allowed
display_value	string	Optional	The server-computed representation of the mapped value, included in GET responses. Omitted from create and update requests. Maximum length: 500
field	Model	Required within parent	Expand Create an Automation Task — request body — body tasks item field mappings item type static field Target field to populate when the automation executes. api_name is required. If id is also provided, both must refer to the same field; otherwise the API returns AMBIGUITY_DURING_PROCESSING.
type	string	Required within parent	Identifies the mapping variant as an execution-time offset. The value is always "execution_time" for this schema and acts as the polymorphic discriminator across the AutomationFieldMappings union. Must equal: execution_time
value	Model	Required within parent	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item type execution time value Execution-time object specifying how to compute the date/datetime offset from a reference field.

Referenced models: Create an Automation Task — request body — body tasks item field mappings item type static field, Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item type execution time value

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item type execution time value

Field	Type	Presence	Description and constraints
$	object	Root	Represents the offset configuration used by an execution_time mapping to compute a final date, datetime, or ALARM value at runtime. Contains period (the time unit granularity), unit (the numeric magnitude expressed as a string integer), and trigger_field (a merge token or ${CURRENTTIME}). Date fields use period, unit, and trigger_field with an implied positive direction. Datetime fields additionally accept sign to control direction. ALARM fields additionally accept time and notify_type, and always require a minus sign. Workflow task actions restrict period to days or business_days. Additional keys: not allowed
notify_type	string	Optional	The notification channel used to deliver the reminder. Applies exclusively when the target field carries data type ALARM (i.e., Remind_At); date and datetime fields do not use this property. Possible values: **popup** — triggers an in-app notification. **email** — sends a message to the task owner. **emailandpopup** — delivers both simultaneously. Known values: popup, email, emailandpopup
period	string	Required within parent	The calendar or time unit applied to the offset. Possible values: **days** — counts all calendar days including weekends and holidays; supported by every action type. **business_days** — excludes weekends and requires the organisation's business-day setting to be enabled; supported by all action types. **hours** — available only for create_record, add_meeting, and schedule_call. **minutes** — available only for create_record, add_meeting, and schedule_call. workflow_tasks accept only **days** or **business_days**. Known values: days, business_days, hours, minutes
sign	string	Optional	The direction of the offset relative to the trigger date. Possible values: **plus** — places the computed value after the trigger (for example, a due date two days after record creation). **minus** — places the computed value before the trigger (for example, a reminder one day before the due date). For datetime fields (data_type=datetime) a value is expected; omitting it returns a DEPENDENT_FIELD_MISSING error. For date-only fields (data_type=date) the value defaults to **plus** when absent. When targeting Remind_At (data_type=ALARM), **minus** is the only applicable direction. Known values: plus, minus Default: plus
time	string	Optional	The time-of-day component of the computed value, expressed in 24-hour HH:mm format (for example, "13:00", "01:30"). Applies when the target field carries data type datetime or ALARM (as reported by GET /settings/fields). Supplying this property for a date-only field (data_type=date) produces a validation error. Maximum length: 20
trigger_field	string	Required within parent	The reference date or datetime field from which the offset is measured. Accepts a merge-field token that resolves to a Date or DateTime field on the parent module (for example, "${!Leads.Modified_Time}", "${!Tasks.Due_Date}"), or the reserved constant "${CURRENTTIME}" to use the automation execution timestamp. When computing a Remind_At (ALARM) value, "${!Tasks.Due_Date}" is the typical anchor. Maximum length: 255
unit	string	Required within parent	The number of period units to offset from the trigger date, supplied as a non-negative integer string (for example, "1", "30"). Passing "0" produces a same-day result, such as scheduling a Remind_At on the same day as the due date. Maximum length: 20 Pattern: ^[0-9]+$

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item lock status

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lock status of a resource, indicating whether it is currently locked or not. Additional keys: not allowed
locked	boolean	Optional	Whether this automation task is locked from editing.

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item modified by

Field	Type	Presence	Description and constraints
$	object	Root	Provides details about the individual who modified an entity, including their name and ID. Additional keys: not allowed
id	string	Optional	Unique Zoho CRM user ID of the modifier. Maximum length: 255
name	string	Optional	Display name of the user who last modified this resource. Maximum length: 255

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item module

Field	Type	Presence	Description and constraints
$	object	Root	Contains module metadata, including labels, API name, IDs, and optional module_name for related module contexts. Additional keys: not allowed
api_name	string	Required within parent	API name of the module used in API requests (e.g., Leads, Contacts, Deals). Maximum length: 255
id	string	Optional	Unique Zoho CRM module ID. Maximum length: 255
moduleName	string	Optional	Module display name (camelCase). Present on parent module objects only. Maximum length: 255
module_name	string	Optional	Module system name (snake_case). Present on related_module objects only. Maximum length: 255
plural_label	string	Optional	Plural display label of the module (e.g., Leads, Contacts). Maximum length: 255
singular_label	string	Optional	Singular display label of the module (e.g., Lead, Contact). Maximum length: 255

Automation Task — workflow Tasks update Workflow Task By Id — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response for updating an automation task. Contains the updated task ID. Additional keys: not allowed
tasks	array	Required within parent	Array containing exactly one result for the updated task. Maximum items: 1
tasks[]	Model	Each item	Expand Create an Automation Task — response body — tasks item

Referenced models: Create an Automation Task — response body — tasks item

Create an Automation Task — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	PURPOSE: Request body wrapper for creating or updating an automation task definition. MUST contain a tasks array with exactly 1 task object. Additional keys: not allowed
tasks	array	Required within parent	REQUIRED. Array containing exactly 1 automation task object. Multiple tasks per request are not supported. Maximum items: 1 Minimum items: 1
tasks[]	Model	Each item	Expand Create an Automation Task — request body — body tasks item

Referenced models: Create an Automation Task — request body — body tasks item

Create an Automation Task — request body — body tasks item

Field	Type	Presence	Description and constraints
$	object	Root	PURPOSE: Writable task fields for create or update. PREREQUISITES: (1) Call GET /settings/layouts?module=Tasks - fields with required: true in the field info are mandatory in field_mappings. (2) Call GET /settings/modules to discover valid module api_names. Read-only fields (id, created_time, modified_time, created_by, modified_by, lock_status, associated, deletable) are excluded. Additional keys: not allowed
feature_type	string	Optional	The automation feature this task definition belongs to. Defaults to "workflow" if omitted. A task can only be associated with the feature it was created for - a task with feature_type="workflow" can only be attached to workflow rules, not to blueprints or kiosks. Supported values are defined in the enum. Default: workflow One of: workflow, approval_process, blueprint, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, kiosks, pathfinder, connected_workflows, commandcenter_service, cadences, scoring_rule, case_escalation_rule Maximum length: 255
field_mappings	array	Required within parent	REQUIRED. Field mappings for task fields. Mandatory mappings: Subject (static or merge_field), Due_Date (execution_time), Status (static: Not Started, Deferred, In Progress, Completed, Waiting on someone else), Priority (static: Highest, High, Normal, Low, Lowest). Optional: Description, Owner, Remind_At (execution_time). Each entry requires field ({api_name, id}), type, and value. Types: static (literal values), merge_field (${!Module.Field} tokens), execution_time (for Date/DateTime/ALARM - requires period, unit, trigger_field, sign). Workflow tasks support period: days, business_days only. Max 20 entries. Maximum items: 20 Minimum items: 1
field_mappings[]	Model	Each item	Expand Create an Automation Task — request body — body tasks item field mappings item
module	Model	Required within parent	Expand Create an Automation Task — request body — body tasks item module
name	string	Required within parent	Display name for this task definition. Must be identical to the value provided in the Subject field_mapping entry. If they do not match, the API returns INVALID_DATA. For merge_field type Subject mappings, set name to the same token string (e.g., "${!Leads.Last_Name}"). Maximum length: 255
notify	boolean	Optional	Whether notification should be sent to the task owner when this automation task executes. Default: false

Referenced models: Create an Automation Task — request body — body tasks item field mappings item, Create an Automation Task — request body — body tasks item module

Create an Automation Task — request body — body tasks item field mappings item

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents a single field-to-value mapping used within automation actions such as workflow tasks, create_record, add_meeting, and schedule_call. Each mapping identifies a target field via api_name or ID, declares a type discriminator that determines value interpretation, and supplies a value whose shape varies by type: static supplies a literal value, merge_field supplies a runtime-resolved token string, execution_time supplies a date or datetime offset object, and composite supplies structured participant data for the Events Participants field. The field_mappings array must include all fields the target module requires; omitting any produces a REQUIRED_DATA_NOT_FOUND error. discriminator: {"mapping": {"composite": "#/components/schemas/CompositeFieldMapping", "execution_time": "#/components/schemas/ExecutionTimeFieldMapping", "merge_field": "#/components/schemas/MergeFieldMapping", "static": "#/components/schemas/StaticFieldMapping"}, "propertyName": "type"}
$ (anyOf 1)	Model	Alternative	Expand Create an Automation Task — request body — body tasks item field mappings item type static
$ (anyOf 2)	Model	Alternative	Expand Create an Automation Task — request body — body tasks item field mappings item type merge field
$ (anyOf 3)	Model	Alternative	Expand Create an Automation Task — request body — body tasks item field mappings item type execution time
$ (anyOf 4)	Model	Alternative	Expand Create an Automation Task — request body — body tasks item field mappings item type composite

Referenced models: Create an Automation Task — request body — body tasks item field mappings item type composite, Create an Automation Task — request body — body tasks item field mappings item type execution time, Create an Automation Task — request body — body tasks item field mappings item type merge field, Create an Automation Task — request body — body tasks item field mappings item type static

Create an Automation Task — request body — body tasks item field mappings item type composite

Field	Type	Presence	Description and constraints
$	object	Root	Represents a composite-type field mapping used exclusively for the Participants field in the Events module via the add_meeting action. The value carries a structured object that encodes participant data and is not applicable to any other field or automation action type. Additional keys: not allowed
display_value	string	Optional	The server-computed representation of the mapped value, included in GET responses. Omitted from create and update requests. Maximum length: 500
field	Model	Required within parent	Expand Create an Automation Task — request body — body tasks item field mappings item type static field Target field to populate when the automation executes. api_name is required. If id is also provided, both must refer to the same field; otherwise the API returns AMBIGUITY_DURING_PROCESSING.
type	string	Required within parent	Serves as the polymorphic discriminator that identifies this field mapping as a composite mapping; the value must be set to "composite" to select this schema variant. Must equal: composite
value	object	Required within parent	Holds the structured composite object that encodes participant data for the Events module Participants field; the shape of this object varies according to the participant type configuration defined for the automation rule. Additional keys: allowed

Referenced models: Create an Automation Task — request body — body tasks item field mappings item type static field

Create an Automation Task — request body — body tasks item field mappings item type execution time

Field	Type	Presence	Description and constraints
$	object	Root	Represents an execution_time-type field mapping that computes a date, datetime, or ALARM value at runtime by applying a signed offset to a trigger field or the current time. The value carries an ExecutionTimeValue object specifying the period, unit, trigger_field, and optional time or notify_type properties. A plus sign places the result after the trigger; a minus sign places it before. ALARM fields always require minus. Workflow task actions support only days and business_days as period values. Additional keys: not allowed
display_value	string	Optional	The server-computed representation of the mapped value, included in GET responses. Omitted from create and update requests. Maximum length: 500
field	Model	Required within parent	Expand Create an Automation Task — request body — body tasks item field mappings item type static field Target field to populate when the automation executes. api_name is required. If id is also provided, both must refer to the same field; otherwise the API returns AMBIGUITY_DURING_PROCESSING.
type	string	Required within parent	Identifies the mapping variant as an execution-time offset. The value is always "execution_time" for this schema and acts as the polymorphic discriminator across the AutomationFieldMappings union. Must equal: execution_time
value	Model	Required within parent	Expand Create an Automation Task — request body — body tasks item field mappings item type execution time value Execution-time object specifying how to compute the date/datetime offset from a reference field.

Referenced models: Create an Automation Task — request body — body tasks item field mappings item type static field, Create an Automation Task — request body — body tasks item field mappings item type execution time value

Create an Automation Task — request body — body tasks item field mappings item type execution time value

Field	Type	Presence	Description and constraints
$	object	Root	Represents the offset configuration used by an execution_time mapping to compute a final date, datetime, or ALARM value at runtime. Contains period (the time unit granularity), unit (the numeric magnitude expressed as a string integer), and trigger_field (a merge token or ${CURRENTTIME}). Date fields use period, unit, and trigger_field with an implied positive direction. Datetime fields additionally accept sign to control direction. ALARM fields additionally accept time and notify_type, and always require a minus sign. Workflow task actions restrict period to days or business_days. Additional keys: not allowed
notify_type	string	Optional	The notification channel used to deliver the reminder. Applies exclusively when the target field carries data type ALARM (i.e., Remind_At); date and datetime fields do not use this property. Possible values: **popup** — triggers an in-app notification. **email** — sends a message to the task owner. **emailandpopup** — delivers both simultaneously. One of: popup, email, emailandpopup
period	string	Required within parent	The calendar or time unit applied to the offset. Possible values: **days** — counts all calendar days including weekends and holidays; supported by every action type. **business_days** — excludes weekends and requires the organisation's business-day setting to be enabled; supported by all action types. **hours** — available only for create_record, add_meeting, and schedule_call. **minutes** — available only for create_record, add_meeting, and schedule_call. workflow_tasks accept only **days** or **business_days**. One of: days, business_days, hours, minutes
sign	string	Optional	The direction of the offset relative to the trigger date. Possible values: **plus** — places the computed value after the trigger (for example, a due date two days after record creation). **minus** — places the computed value before the trigger (for example, a reminder one day before the due date). For datetime fields (data_type=datetime) a value is expected; omitting it returns a DEPENDENT_FIELD_MISSING error. For date-only fields (data_type=date) the value defaults to **plus** when absent. When targeting Remind_At (data_type=ALARM), **minus** is the only applicable direction. Default: plus One of: plus, minus
time	string	Optional	The time-of-day component of the computed value, expressed in 24-hour HH:mm format (for example, "13:00", "01:30"). Applies when the target field carries data type datetime or ALARM (as reported by GET /settings/fields). Supplying this property for a date-only field (data_type=date) produces a validation error. Maximum length: 20
trigger_field	string	Required within parent	The reference date or datetime field from which the offset is measured. Accepts a merge-field token that resolves to a Date or DateTime field on the parent module (for example, "${!Leads.Modified_Time}", "${!Tasks.Due_Date}"), or the reserved constant "${CURRENTTIME}" to use the automation execution timestamp. When computing a Remind_At (ALARM) value, "${!Tasks.Due_Date}" is the typical anchor. Maximum length: 255
unit	string	Required within parent	The number of period units to offset from the trigger date, supplied as a non-negative integer string (for example, "1", "30"). Passing "0" produces a same-day result, such as scheduling a Remind_At on the same day as the due date. Maximum length: 20 Pattern: ^[0-9]+$

Create an Automation Task — request body — body tasks item field mappings item type merge field

Field	Type	Presence	Description and constraints
$	object	Root	Represents a merge_field-type mapping whose value is resolved at execution time by substituting token references with live field data. Supports direct field tokens (${!Module.Field}), traversal tokens (${!Module.Lookup.Field}), and system tokens (${CURRENTTIME}, ${CURRENTUSER}). Applies to text-based fields such as Subject, Description, and custom text fields. Targeting owner or lookup fields with this type produces a DEPENDENT_MISMATCH error; those fields require a static mapping using an object with a numeric identifier and an optional name. Multiple tokens may be chained with surrounding text for multi-line fields, while single-value fields such as email or URL accept exactly one token. Additional keys: not allowed
allow_agent_user	boolean	Optional	Controls whether agent users are eligible for record assignment. Possible values: **true** — agent users are included in the assignment pool alongside standard users. **false** — agent users are excluded from assignment. Applies to mapping types role, group, profile, merge_field, and criteria. Does not apply to user or assignment_rule types. Default: false
display_value	string	Optional	The server-computed representation of the mapped value, included in GET responses. Omitted from create and update requests. Maximum length: 500
field	Model	Required within parent	Expand Create an Automation Task — request body — body tasks item field mappings item type static field Target field to populate when the automation executes. api_name is required. If id is also provided, both must refer to the same field; otherwise the API returns AMBIGUITY_DURING_PROCESSING.
type	string	Required within parent	Identifies the mapping strategy for this field assignment. The value must be `merge_field`, which instructs the automation engine to resolve the field value dynamically from a merge field token at execution time rather than from a static literal. Must equal: merge_field
value	string	Required within parent	Represents the string value carried by a merge_field mapping, containing one or more runtime-resolved token references. Supports direct field tokens (${!Module.Field}), lookup traversal tokens (${!Module.Lookup.Field}), and system tokens (${CURRENTTIME}, ${CURRENTUSER}). Tokens may be combined with surrounding text for multi-line field targets. Fields that hold a single typed value such as email or URL accept exactly one token. A string containing one or more ${!...} merge-field tokens resolved at runtime. Maximum length: 1000

Referenced models: Create an Automation Task — request body — body tasks item field mappings item type static field

Create an Automation Task — request body — body tasks item field mappings item type static

Field	Type	Presence	Description and constraints
$	object	Root	Represents a static-type mapping that assigns a literal value directly to the target field at execution time. The value shape varies by field data type: a plain string for text, picklist, phone, email, URL, number, decimal, currency, and percentage fields (numeric values expressed as strings); an array of strings for multiselectpicklist fields; and an object containing ID and name for ownerlookup fields. Date, datetime, and ALARM fields do not support this type — use execution_time instead, as static on those fields produces a DEPENDENT_MISMATCH error. Fields marked unique in the module settings also require merge_field rather than static for create_record actions. Additional keys: not allowed
display_value	string	Optional	The server-computed representation of the mapped value, included in GET responses. Omitted from create and update requests. Maximum length: 500
field	Model	Required within parent	Expand Create an Automation Task — request body — body tasks item field mappings item type static field Target field to populate when the automation executes. api_name is required. If id is also provided, both must refer to the same field; otherwise the API returns AMBIGUITY_DURING_PROCESSING.
type	string	Required within parent	Identifies the mapping strategy for this field assignment. The value must be `static`, which instructs the automation engine to assign a fixed, literal value to the target field at execution time rather than resolving it dynamically. Must equal: static
value	JSON	Required within parent	The literal value assigned to the target field at automation execution time. The expected shape is determined by the target field data_type, discoverable via GET /settings/fields?module={module}. For most field types, supply a string (for example, "High", "Not Started", "1234"). For multi-select picklist fields (data_type: multiselectpicklist), supply an array of option strings. For fields that reference an entity such as an owner or layout (data_type: ownerlookup), supply an object with at minimum the entity ID.
value (anyOf 1)	string	Alternative	Represents a plain string value used as the static value for text, picklist, phone, email, URL, number, decimal, currency, and percentage fields. Numeric values are expressed as strings rather than numeric literals. Picklist values must exactly match one of the options defined for the field. Maximum length: 1000
value (anyOf 2)	Model	Alternative	Expand Create an Automation Task — request body — body tasks item field mappings item type static value array
value (anyOf 3)	Model	Alternative	Expand Create an Automation Task — request body — body tasks item field mappings item type static value id, name

Referenced models: Create an Automation Task — request body — body tasks item field mappings item type static field, Create an Automation Task — request body — body tasks item field mappings item type static value array, Create an Automation Task — request body — body tasks item field mappings item type static value id, name

Create an Automation Task — request body — body tasks item field mappings item type static field

Field	Type	Presence	Description and constraints
$	object	Root	Identifies the target CRM field to which a mapping value is applied within an automation rule. The api_name and ID properties must both be supplied and must refer to the same field; a mismatch between the two causes an AMBIGUITY_DURING_PROCESSING error. Available fields for a given module can be discovered via GET /settings/fields?module={api_name}. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the target field in the destination module — for example, Subject, Due_Date, or Owner — used to identify the field receiving the mapped value within automation actions such as workflow tasks, create_record, and convert. Maximum length: 255
id	string	Required within parent	Represents the numeric identifier of the target CRM field. Used in conjunction with the field's API name, both of which must resolve to the same field for a mapping to be valid. Maximum length: 255

Create an Automation Task — request body — body tasks item field mappings item type static value array

Field	Type	Presence	Description and constraints
$	array	Root	Represents an array of string values used as the static value for multiselectpicklist fields, where each element corresponds to an available picklist option. Valid option labels are retrievable from the GET /settings/fields endpoint filtered by data_type=multiselectpicklist. Maximum items: 50 Minimum items: 1
$[]	string	Each item	A single picklist option string to include in the multi-select field value. Each entry corresponds to one selectable option as defined for the target field in Zoho CRM. Maximum length: 255

Create an Automation Task — request body — body tasks item field mappings item type static value id, name

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object value used as the static value for ownerlookup and layout fields, containing an ID that identifies the target user or layout and an optional name that the server resolves from the ID when not supplied. Typically used to assign record ownership by providing the user ID. Additional keys: allowed
id	string	Required within parent	The system identifier of the referenced entity, such as a user or layout record. This value drives entity resolution by the automation engine and must be provided when the target field references an entity. Maximum length: 255
name	string	Optional	The display name of the referenced entity, such as a user full name or a layout label. When omitted from a request payload, the server resolves and populates this property from the supplied ID. The property is present in all GET responses. Maximum length: 255

Create an Automation Task — request body — body tasks item module

Field	Type	Presence	Description and constraints
$	object	Root	PURPOSE: The CRM module this task definition belongs to. Specifies which module's records will trigger task creation - not the Tasks module itself. PREREQUISITES: Call GET /settings/modules to discover available module api_names and IDs. api_name is required, id is optional. Additional keys: not allowed
api_name	string	Required within parent	REQUIRED. API name of the CRM module whose records trigger this task creation (e.g., Leads, Contacts, Deals). Use GET /settings/modules to discover available modules. Maximum length: 255
id	string	Optional	Optional module ID. If provided alongside api_name, both must refer to the same module. Maximum length: 255

Create an Automation Task — response body

Field	Type	Presence	Description and constraints
$	object	Root	Successful response after creating an automation task definition. Additional keys: not allowed
tasks	array	Required within parent	Array containing the created task result. Maximum items: 1
tasks[]	Model	Each item	Expand Create an Automation Task — response body — tasks item

Referenced models: Create an Automation Task — response body — tasks item

Create an Automation Task — response body — tasks item

Field	Type	Presence	Description and constraints
$	object	Root	Result of a task create, update, or delete operation. Additional keys: not allowed
code	string	Required within parent	Operation result code (e.g., SUCCESS). Maximum length: 255
details	Model	Required within parent	Expand Create an Automation Task — response body — tasks item details
message	string	Required within parent	Result message describing the outcome of the task action. Maximum length: 255
status	string	Required within parent	Operation result status (e.g., success). Maximum length: 255

Referenced models: Create an Automation Task — response body — tasks item details

Create an Automation Task — response body — tasks item details

Field	Type	Presence	Description and constraints
$	object	Root	Details returned with a task action result, including the created or affected resource ID. Additional keys: not allowed
id	string	Required within parent	Unique ID of the created or affected automation task. Maximum length: 20
resource_path_index	string	Optional	Index of the resource in the request payload array. Maximum length: 255

Delete automation task definitions by I Ds (bulk) — response body — tasks tasks item

Field	Type	Presence	Description and constraints
$	object	Root	Result item for a task ID that was deleted successfully in a bulk delete operation. Additional keys: not allowed
code	string	Required within parent	Result code. Known values: SUCCESS
details	object	Required within parent	Contains the deleted task ID. Additional keys: not allowed
details.id	string	Required within parent	Unique ID of the deleted task. Maximum length: 20
message	string	Required within parent	Success message. Maximum length: 255
status	string	Required within parent	Operation status. Known values: success

Delete automation task definitions by I Ds (bulk) — response body — tasks — Bulk Delete Tasks Mixed Response

Field	Type	Presence	Description and constraints
$	object	Root	Bulk delete partial-success response. Contains mixed success and failure items for the requested task IDs. Additional keys: not allowed
tasks	array	Required within parent	Per-ID deletion results for the bulk request. Maximum items: 10
tasks[]	JSON	Each item	Represents a single per-ID outcome entry returned in a bulk DELETE request, indicating either a successful delete or a per-ID failure reason.
tasks[] (anyOf 1)	Model	Alternative	Expand Delete automation task definitions by I Ds (bulk) — response body — tasks tasks item
tasks[] (anyOf 2)	Model	Alternative	Expand Delete automation task definitions by IDs (bulk) — response body — tasks / tasks / item / code: INVALID DATA, NOT ALLOWED, status: error

Referenced models: Delete automation task definitions by IDs (bulk) — response body — tasks / tasks / item / code: INVALID DATA, NOT ALLOWED, status: error, Delete automation task definitions by I Ds (bulk) — response body — tasks tasks item

Delete automation task definitions by I Ds (bulk) — response body — tasks — Bulk Delete Tasks Success Response

Field	Type	Presence	Description and constraints
$	object	Root	Bulk delete success response. All requested task IDs were deleted successfully. Additional keys: not allowed
tasks	array	Required within parent	Deletion result entries for each requested task ID. Maximum items: 10
tasks[]	Model	Each item	Expand Delete automation task definitions by I Ds (bulk) — response body — tasks tasks item

Referenced models: Delete automation task definitions by I Ds (bulk) — response body — tasks tasks item

Delete automation task definitions by IDs (bulk) — response body — tasks / tasks / item / code: INVALID DATA, NOT ALLOWED, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Result item for a task ID that failed during bulk delete. Code is INVALID_DATA when the ID does not exist, or NOT_ALLOWED when the task is associated with a rule/blueprint or is read-only. Additional keys: not allowed
code	string	Required within parent	Failure code. Known values: INVALID_DATA, NOT_ALLOWED
details	object	Required within parent	Contains the failed task ID. Additional keys: not allowed
details.id	string	Required within parent	ID of the task that could not be deleted. Maximum length: 20
message	string	Required within parent	Failure message. Maximum length: 255
status	string	Required within parent	Operation status. Known values: error

List automation task definitions with optional filters — response body — info, tasks

Field	Type	Presence	Description and constraints
$	object	Root	Paginated response containing automation tasks and pagination metadata. Additional keys: not allowed
info	Model	Required within parent	Expand List automation task definitions with optional filters — response body — info, tasks info
tasks	array	Required within parent	List of automation task definitions for the current query page. Maximum items: 200
tasks[]	Model	Each item	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item

Referenced models: Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item, List automation task definitions with optional filters — response body — info, tasks info

List automation task definitions with optional filters — response body — info, tasks info

Field	Type	Presence	Description and constraints
$	object	Root	Details about pagination for resource listings, such as count, page number, and if more records are available. Additional keys: not allowed
count	JSON	Optional
count (anyOf 1)	integer	Alternative	Number of records/actions returned in the current response page. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_records	boolean	Optional	Indicates whether additional records/actions are available beyond the current page.
page	JSON	Optional
page (anyOf 1)	integer	Alternative	Current page number in the paginated result set (typically reflects the requested page value). Format: int32
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_page	JSON	Optional
per_page (anyOf 1)	integer	Alternative	Maximum number of records/actions requested per page. Format: int32
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$