Skip to content

Zoho: Automation functions schemas

26 Zoho schemas with complete fields and constraints.

← Automation functions operations · All schemas

Create Automation Function — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents a request payload containing an array of automation function definitions.
Additional keys: not allowed
functionsarrayRequired within parentRepresents the array of automation function definitions included in the request.
Maximum items: 1
functions[]ModelEach itemExpand Create Automation Function — request body — body functions item

Referenced models: Create Automation Function — request body — body functions item

Create Automation Function — request body — body functions item

FieldTypePresenceDescription and constraints
$objectRootRepresents an automation function definition, including its feature type, associated module, linked function, name, language, description, and arguments.
Additional keys: not allowed
argumentsarrayOptionalRepresents the list of arguments configured for the automation function.
Maximum items: 50
arguments[]ModelEach itemExpand Create Automation Function — request body — body functions item arguments item
descriptionstringOptionalThe description of the automation function.
Maximum length: 5000
feature_typestringOptionalThe CRM automation feature type with which the function is associated. Possible values: **workflow** - A Workflow Rule automation feature. **approval_process** - An Approval Process automation feature. **blueprint** - A Blueprint automation feature. **blueprint_transition** - A Blueprint transition automation feature. **blueprint_state** - A Blueprint state automation feature. **review_process** - A review process automation feature. **orchestration** - An orchestration automation feature. **assignment_rules** - An Assignment Rule automation feature. **kiosk** - A kiosk automation feature. **pathfinder** - A pathfinder automation feature. **connected_workflows** - A connected workflows automation feature. **commandcenter_service** - A Command Center service automation feature. **cadences** - A Cadences automation feature.
One of: workflow, approval_process, blueprint, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, kiosk, pathfinder, connected_workflows, commandcenter_service, cadences
Maximum length: 22
functionModelRequired within parentExpand Create Automation Function — request body — body functions item function
function details (Required)
languagestringRequired within parentRepresents the programming language of the automation function. Possible values: **deluge** - Deluge scripting language. **python** - Python (legacy). **java** - Java (legacy). **node_js** - Node.js (legacy). **python_3_12** - Python 3.12. **java17** - Java 17. **nodejs_22** - Node.js 22. **nodejs** - Node.js. **golang** - Go programming language.
One of: deluge, python, java, node_js, python_3_12, java17, nodejs_22, nodejs, GOlang
Maximum length: 11
moduleModelRequired within parentExpand Create Automation Function — request body — body functions item module
Module of the function (Required)
namestringRequired within parentThe name of the automation function.
Maximum length: 250
related_moduleModelOptionalExpand Create Automation Function — request body — body functions item module
Related module information if applicable

Referenced models: Create Automation Function — request body — body functions item arguments item, Create Automation Function — request body — body functions item function, Create Automation Function — request body — body functions item module

Create Automation Function — request body — body functions item arguments item

FieldTypePresenceDescription and constraints
$objectRootRepresents name, type and value that defines a single argument passed to an automation function.
Additional keys: not allowed
namestringRequired within parentRepresents the name of the automation function argument.
Maximum length: 100
typestringRequired within parentThe type of the automation function argument. Possible values:
* **static** - The argument uses a fixed, literal value.
* **merge_field** - The argument uses a dynamic value merged from a CRM field.

One of: static, merge_field
Maximum length: 255
valuestringRequired within parentRepresents the value assigned to the automation function argument.
Maximum length: 1000

Create Automation Function — request body — body functions item function

FieldTypePresenceDescription and constraints
$objectRootRepresents an automation function link input, containing the identifier of a custom function to associate within an automation definition.
Additional keys: not allowed
idstringRequired within parentThe unique identifier of the custom function to associate with the automation definition.
Format: int64
Maximum length: 18

Create Automation Function — request body — body functions item module

FieldTypePresenceDescription and constraints
$objectRootRepresents the module selector used to identify a CRM module by its API name or ID when modifying an automation function.
Additional keys: not allowed
api_namestringOptionalRepresents the API name of the module.
Maximum length: 5
idstringOptionalRepresents the unique ID of the module.
Format: int64
Maximum length: 18

Create Automation Function — response body

FieldTypePresenceDescription and constraints
$objectRootIndicates the response returned after submitting automation function definitions, containing per-item results in a **functions** array.
Additional keys: not allowed
functionsarrayRequired within parentThe list of per-item results from the automation function creation operation.
Maximum items: 1
functions[]ModelEach itemExpand Create Automation Function — response body — functions item

Referenced models: Create Automation Function — response body — functions item

Create Automation Function — response body — functions item

FieldTypePresenceDescription and constraints
$objectRootRepresents the result of processing an automation function action, including a status code, message, and associated details.
Additional keys: not allowed
codestringRequired within parentThe status code indicating the outcome of the automation function action. Possible values: **SUCCESS** - The automation function action was processed successfully.
Known values: SUCCESS
detailsModelRequired within parentExpand Create Automation Function — response body — functions item details
messagestringRequired within parentThe message describing the result of the operation.
Maximum length: 255
statusstringRequired within parentThe overall status of the operation. Possible values: **success** - The operation completed successfully.
Known values: success

Referenced models: Create Automation Function — response body — functions item details

Create Automation Function — response body — functions item details

FieldTypePresenceDescription and constraints
$objectRootOperation details for a processed automation function, including the resulting resource identifier.
Additional keys: not allowed
idstringRequired within parentThe unique identifier of the automation function that was processed.
Format: int64

Delete Automation Function — response body

FieldTypePresenceDescription and constraints
$objectRootThe response returned after deleting a single automation function, containing the result of the deletion operation.
Additional keys: not allowed
functionsarrayRequired within parentThe list of deletion results for the specified automation functions.
Maximum items: 200
functions[]ModelEach itemExpand Create Automation Function — response body — functions item

Referenced models: Create Automation Function — response body — functions item

Delete Functions — response body — functions

FieldTypePresenceDescription and constraints
$objectRootThe response returned after removing one or more automation functions in bulk, containing per-item results for each function in the request.
Additional keys: not allowed
functionsarrayRequired within parentThe list of individual removal results, one entry per automation function included in the bulk request.
Maximum items: 200
Minimum items: 2
functions[]JSONEach itemThe removal result for a single automation function, indicating whether the function was successfully removed.
functions[] (anyOf 1)ModelAlternativeExpand Create Automation Function — response body — functions item
functions[] (anyOf 2)ModelAlternativeExpand Delete Functions — response body — functions / functions / item / code: INVALID DATA, status: error
functions (allOf 1)JSONAll variants applyEnsures at least one success result is present in the response.
functions (allOf 2)JSONAll variants applyEnsures at least one invalid data error result is present in the response.

Referenced models: Create Automation Function — response body — functions item, Delete Functions — response body — functions / functions / item / code: INVALID DATA, status: error

Delete Functions — response body — functions / functions / item / code: INVALID DATA, status: error

FieldTypePresenceDescription and constraints
$objectRootError result returned when an invalid function ID is specified during bulk deletion.
Additional keys: not allowed
codestringRequired within parentThe error code identifying the type of error. Possible values: **INVALID_DATA** - The request contains an invalid function ID.
Known values: INVALID_DATA
detailsModelRequired within parentExpand Create Automation Function — response body — functions item details
messagestringRequired within parentThe error message describing the issue.
Maximum length: 255
statusstringRequired within parentRepresents the status of the response. Possible values: **error** - Indicates that the request resulted in an error.
Known values: error

Referenced models: Create Automation Function — response body — functions item details

Get Associated Modules for Automation Functions — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response containing the list of modules associated with automation functions.
Additional keys: not allowed
associated_modulesarrayRequired within parentRepresents the list of CRM modules associated with the automation functions.
Maximum items: 12
associated_modules[]ModelEach itemExpand Get Associated Modules for Automation Functions — response body — associated modules item

Referenced models: Get Associated Modules for Automation Functions — response body — associated modules item

Get Associated Modules for Automation Functions — response body — associated modules item

FieldTypePresenceDescription and constraints
$objectRootA reference to a CRM module associated with an automation function, identified by its API name and unique ID.
Additional keys: not allowed
api_namestringRequired within parentRepresents the API name of the associated CRM module.
Maximum length: 255
idstringRequired within parentRepresents the unique ID of the associated CRM module.
Format: int64

Get Automation Function — response body — functions

FieldTypePresenceDescription and constraints
$objectRootRepresents the response containing automation function records returned for the requested query.
Additional keys: not allowed
functionsarrayRequired within parentThe list of automation function detail records matching the query.
Maximum items: 1
functions[]ModelEach itemExpand Get Automation Functions — response body — functions item

Referenced models: Get Automation Functions — response body — functions item

Get Automation Functions — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response for an automation functions list request, including the list of functions and pagination information.
Additional keys: not allowed
functionsarrayRequired within parentRepresents the list of automation functions returned in the response.
Maximum items: 200
functions[]ModelEach itemExpand Get Automation Functions — response body — functions item
infoModelRequired within parentExpand Get Automation Functions — response body — info

Referenced models: Get Automation Functions — response body — functions item, Get Automation Functions — response body — info

Get Automation Functions — response body — functions item

FieldTypePresenceDescription and constraints
$objectRootRepresents the details of an automation function, including its metadata, module context, script reference, language, lock status, ownership, and configured arguments.
Additional keys: not allowed
argumentsarrayOptionalRepresents the list of arguments configured for the automation function.
Maximum items: 50
arguments[]ModelEach itemExpand Get Automation Functions — response body — functions item arguments item
associatedbooleanRequired within parentIndicates whether the automation function is currently associated with a workflow or action. Possible values:
* **true** - The automation function is associated with a workflow or action.
* **false** - The automation function is not associated with any workflow or action.
created_byModelRequired within parentExpand Get Automation Functions — response body — functions item created by
created_timestringRequired within parentThe timestamp when the automation function was created.
Maximum length: 255
deletablebooleanRequired within parentIndicates whether the automation function can be deleted. Possible values:
* **true** - The automation function can be deleted.
* **false** - The automation function cannot be deleted."
descriptionJSONOptional
description (anyOf 1)stringAlternativeA brief description of the automation function's purpose.
Maximum length: 5000
description (anyOf 2)nullAlternativeA brief description of the automation function's purpose.
Maximum length: 5000
editablebooleanRequired within parentIndicates whether the automation function can be edited. Possible values:
* **true** - The automation function can be edited.
* **false** - The automation function cannot be edited.
feature_typestringRequired within parentThe feature type classification of the automation function. Possible values:
* **workflow**
* **approval_process**
* **blueprint**
* **blueprint_transition**
* **blueprint_state**
* **review_process**
* **orchestration**
* **assignment_rules**
* **kiosk**
* **pathfinder**
* **connected_workflows**
* **commandcenter_service**
* **cadences**

Known values: workflow, approval_process, blueprint, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, kiosk, pathfinder, connected_workflows, commandcenter_service, cadences
Maximum length: 22
functionModelRequired within parentExpand Get Automation Functions — response body — functions item function
idstringRequired within parentRepresents the unique identifier of the automation function.
Format: int64
languagestringRequired within parentThe programming language used in the automation function script. Possible values:
* **deluge** - Deluge scripting language.
* **python** - Python language.
* **java** - Java language. **node_js** - Node.js runtime.
* **python_3_12** - Python 3.12 runtime.
* **java17** - Java 17 runtime.
* **nodejs_22** - Node.js 22 runtime.
* **nodejs** - Node.js runtime.
* **GOlang** - Go programming language.

Known values: deluge, python, java, node_js, python_3_12, java17, nodejs_22, nodejs, GOlang
Maximum length: 255
lock_statusModelRequired within parentExpand Get Automation Functions — response body — functions item lock status
modified_byModelRequired within parentExpand Get Automation Functions — response body — functions item modified by
modified_timestringRequired within parentThe timestamp when the automation function was last modified.
Maximum length: 255
moduleModelRequired within parentExpand Get Automation Functions — response body — functions item module
namestringRequired within parentRepresents the display name of the automation function.
Maximum length: 250
related_moduleJSONOptionalThe CRM module associated with the automation function, if applicable.
related_module (anyOf 1)nullAlternativeIndicates no related module is associated with this automation function.
related_module (anyOf 2)ModelAlternativeExpand Get Automation Functions — response body — functions item module
sourcestringRequired within parentThe source or origin from which the automation function was created.
Maximum length: 255

Referenced models: Get Automation Functions — response body — functions item lock status, Get Automation Functions — response body — functions item module, Get Automation Functions — response body — functions item function, Get Automation Functions — response body — functions item created by, Get Automation Functions — response body — functions item modified by, Get Automation Functions — response body — functions item arguments item

Get Automation Functions — response body — functions item arguments item

FieldTypePresenceDescription and constraints
$objectRootRepresents name, type and value that defines a single argument passed to an automation function.
Additional keys: not allowed
namestringRequired within parentRepresents the name of the automation function argument.
Maximum length: 100
typestringRequired within parentThe type of the automation function argument. Possible values:
* **static** - The argument uses a fixed, literal value.
* **merge_field** - The argument uses a dynamic value merged from a CRM field.

Known values: static, merge_field
Maximum length: 255
valuestringRequired within parentRepresents the value assigned to the automation function argument.
Maximum length: 1000

Get Automation Functions — response body — functions item created by

FieldTypePresenceDescription and constraints
$objectRootA minimal reference to the user who created the automation function, including the user ID and display name.
Additional keys: not allowed
idstringRequired within parentRepresents the unique identifier of the user who created the automation function.
Format: int64
namestringRequired within parentRepresents the display name of the user who created the automation function.
Maximum length: 255

Get Automation Functions — response body — functions item function

FieldTypePresenceDescription and constraints
$objectRootReference to the underlying function by API name and identifier.
Additional keys: not allowed
api_namestringOptionalRepresents the API name of the automation function.
Maximum length: 255
idstringRequired within parentRepresents the unique identifier of the automation function.
Format: int64

Get Automation Functions — response body — functions item lock status

FieldTypePresenceDescription and constraints
$objectRootThe lock status of an automation function, indicating whether editing is currently restricted.
Additional keys: not allowed
lockedbooleanRequired within parentIndicates whether the automation function is currently locked from editing. Possible values:
* **true** - The automation function is locked and cannot be edited.
* **false** - The automation function is unlocked and available for editing.

Get Automation Functions — response body — functions item modified by

FieldTypePresenceDescription and constraints
$objectRootRepresents a reference to the user who last modified a record, including the user's display name and unique ID.
Additional keys: not allowed
idstringRequired within parentRepresents the unique ID of the user who last modified the record.
Format: int64
namestringRequired within parentRepresents the display name of the user who last modified the record.
Maximum length: 255

Get Automation Functions — response body — functions item module

FieldTypePresenceDescription and constraints
$objectRootModule metadata associated with the automation function, including singular and plural labels, API name, internal name, and identifier.
Additional keys: not allowed
api_namestringRequired within parentRepresents the API name of the module associated with the automation function.
Maximum length: 255
idstringRequired within parentThe unique identifier of the module associated with the automation function.
Format: int64
moduleNamestringOptionalRepresents the internal name of the module.
Maximum length: 255
plural_labelstringOptionalRepresents the plural display label of the module.
Maximum length: 255
singular_labelstringOptionalRepresents the singular display label of the module.
Maximum length: 255

Get Automation Functions — response body — info

FieldTypePresenceDescription and constraints
$objectRootRepresents the pagination metadata returned with list responses, including the number of records per page, total record count, current page number, and whether additional records are available.
Additional keys: not allowed
countJSONRequired within parent
count (anyOf 1)integerAlternativeRepresents the total number of records in the current page.
Format: int32
count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_recordsbooleanRequired within parentIndicates whether additional records are available beyond the current page. Possible values: **true** - Additional records exist beyond the current page. **false** - No additional records exist beyond the current page.
pageJSONRequired within parent
page (anyOf 1)integerAlternativeRepresents the current page number in the paginated response.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_pageJSONRequired within parent
per_page (anyOf 1)integerAlternativeRepresents the number of records returned per page in the response.
Format: int32
per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update Automation Function — automation Functions put Automation Functions — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the request payload for modifying one or more automation functions in a batch operation.
Additional keys: not allowed
functionsarrayRequired within parentRepresents the list of automation function change sets included in the modification request.
Maximum items: 1
functions[]ModelEach itemExpand Update Automation Function — automation Functions put Automation Functions — request body — body functions item

Referenced models: Update Automation Function — automation Functions put Automation Functions — request body — body functions item

Update Automation Function — automation Functions put Automation Functions — request body — body functions item

FieldTypePresenceDescription and constraints
$objectRootRepresents an automation function modification request, including the feature type, target module, arguments, and the function ID to update.
Additional keys: not allowed
argumentsarrayOptionalRepresents the list of arguments configured for the automation function.
Maximum items: 50
arguments[]ModelEach itemExpand Create Automation Function — request body — body functions item arguments item
feature_typestringOptionalThe automation feature type associated with the function. Possible values:
* **workflow**
* **approval_process**
* **blueprint**
* **blueprint_transition**
* **blueprint_state**
* **review_process**
* **orchestration**
* **assignment_rules**
* **kiosk**
* **pathfinder**
* **connected_workflows**
* **commandcenter_service**
* **cadences**

One of: workflow, approval_process, blueprint, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, kiosk, pathfinder, connected_workflows, commandcenter_service, cadences
Maximum length: 22
idstringRequired within parentRepresents the unique identifier of the automation function to update.
Format: int64
Maximum length: 18
moduleModelOptionalExpand Create Automation Function — request body — body functions item module
Module Datas
related_moduleModelOptionalExpand Create Automation Function — request body — body functions item module
Related module information if applicable

Referenced models: Create Automation Function — request body — body functions item arguments item, Create Automation Function — request body — body functions item module

Update Automation Function — automation Functions put Automation Functions — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned after submitting automation function modifications, containing per-item results for each submitted function.
Additional keys: not allowed
functionsarrayRequired within parentRepresents the list of per-item results for each automation function modification submitted in the request.
Maximum items: 1
functions[]ModelEach itemExpand Create Automation Function — response body — functions item

Referenced models: Create Automation Function — response body — functions 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.