Skip to content

Zoho: Functions schemas

28 Zoho schemas with complete fields and constraints.

← Functions operations · All schemas

Function Categories — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the successful response for retrieving the list of available categories in the Zoho CRM organization.
Additional keys: not allowed
categoriesarrayRequired within parentRepresents the list of categories available in the Zoho CRM organization.
Maximum items: 100
categories[]ModelEach itemExpand Function Categories — response body — categories item

Referenced models: Function Categories — response body — categories item

Function Categories — response body — categories item

FieldTypePresenceDescription and constraints
$objectRootRepresents a function category entry, including its name and whether it is allowed for the current account.
Additional keys: not allowed
allowedbooleanRequired within parentIndicates whether functions of this category can be created in the current account. Possible values: **true** - Functions of this category are allowed. **false** - Functions of this category are not allowed.
categorystringRequired within parentRepresents the category of the function. Possible values: **Button** - A function triggered by a button action. **Automation** - A function triggered by an automation rule. **Schedule** - A function triggered on a scheduled basis. **Related List** - A function associated with a related list. **Standalone** - A function that runs independently. **Signals** - A function triggered by Signals notifications. **Validation Rule** - A function associated with a Validation Rule. **Dynamic** - A function that executes dynamically.
Known values: Button, Automation, Schedule, Related List, Standalone, Signals, Validation Rule, Dynamic

Function — functions create Functions — response body — functions — Postfunctions Response201

FieldTypePresenceDescription and constraints
$objectRootThe response returned after a function is successfully created in the Zoho CRM organization. For Deluge functions, the function is auto-published upon creation. For non-Deluge functions that include a publish object, the function is created and published; omitting the publish object keeps the function as a draft.
Additional keys: not allowed
functionsarrayRequired within parentThe list of function creation result objects returned by the operation.
Maximum items: 1
functions[]ModelEach itemExpand Function — functions delete Function — response body — functions item

Referenced models: Function — functions delete Function — response body — functions item

Function — functions create Functions — response body — functions — Postfunctions Response207

FieldTypePresenceDescription and constraints
$objectRootRepresents a partial success response for function creation, where the function was created as a draft but the publish step failed due to compilation errors in the uploaded code.
Additional keys: not allowed
functionsarrayRequired within parentContains the partial success details for the created function.
Maximum items: 1
functions[]ModelEach itemExpand Update a function by identifier — response body — functions functions item

Referenced models: Update a function by identifier — response body — functions functions item

Function — functions delete Function — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned after a successful function deletion, containing the details of the deleted functions.
Additional keys: not allowed
functionsarrayRequired within parentThe list of function deletion result items returned in the response.
Maximum items: 1
functions[]ModelEach itemExpand Function — functions delete Function — response body — functions item

Referenced models: Function — functions delete Function — response body — functions item

Function — functions delete Function — response body — functions item

FieldTypePresenceDescription and constraints
$objectRootRepresents a success result for a function create, update, or delete operation, including the operation result code, the function ID, a status indicator, and a descriptive message.
Additional keys: not allowed
codestringRequired within parentRepresents the operation result code. Possible values: **SUCCESS** - The operation completed successfully.
Known values: SUCCESS
detailsModelRequired within parentExpand Publish a function — response body — publish item details
messagestringRequired within parentRepresents the message describing the outcome of the operation.
Maximum length: 255
statusstringRequired within parentRepresents the status of the operation. Possible values: **success** - The operation completed without errors.
Known values: success

Referenced models: Publish a function — response body — publish item details

Function — functions get Function — response body — functions

FieldTypePresenceDescription and constraints
$objectRootThe successful response returned when retrieving one or more functions from the Zoho CRM organization.
Additional keys: not allowed
functionsarrayRequired within parentThe list of function metadata objects returned by the operation.
Maximum items: 200
functions[]ModelEach itemExpand Function — functions get Function — response body — functions functions item

Referenced models: Function — functions get Function — response body — functions functions item

Function — functions get Function — response body — functions functions item

FieldTypePresenceDescription and constraints
$objectRootThe complete metadata for a function, including its identification, configuration, runtime details, state, ownership, and associated tags.
Additional keys: not allowed
TagarrayRequired within parentThe list of tags associated with the function.
Maximum items: 200
Tag[]ModelEach itemExpand Function — functions get Function — response body — functions functions item Tag item
api_namestringRequired within parentRepresents the unique programmatic identifier for the function, used in API calls and automation references.
Maximum length: 100
Pattern: ^[A-Za-z][A-Za-z0-9_-]*$
argumentsJSONRequired within parent
arguments (anyOf 1)arrayAlternativeList of input arguments accepted by the function. Null if the function takes no arguments.
Maximum items: 50
arguments (anyOf 1)[]ModelEach itemExpand Function — functions get Function — response body — functions functions item arguments null item
arguments (anyOf 2)nullAlternativeList of input arguments accepted by the function. Null if the function takes no arguments.
Maximum items: 50
arguments (anyOf 2)[]ModelEach itemExpand Function — functions get Function — response body — functions functions item arguments null item
categorystringRequired within parentThe trigger category that determines how and when the function executes. Possible values: **Related List** - The function is triggered from a related list context. **Validation Rule** - The function executes as part of a Validation Rule. **Schedule** - The function runs on a scheduled basis. **Automation** - The function is triggered by an automation event. **Standalone** - The function runs independently without a trigger context. **Signals** - The function is triggered by a Signals event. **Button** - The function executes when a button is clicked. **Dynamic** - The function operates in a dynamic context.
Known values: Related List, Validation Rule, Schedule, Automation, Standalone, Signals, Button, Dynamic
created_byModelRequired within parentExpand Function — functions get Function — response body — functions functions item created by
created_timestringRequired within parentThe timestamp when the function was created.
Format: date-time
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeThe description of the function's purpose and behavior provided by the user. Null if no description has been set.
Maximum length: 3000
description (anyOf 2)nullAlternativeThe description of the function's purpose and behavior provided by the user. Null if no description has been set.
Maximum length: 3000
has_draftbooleanRequired within parentIndicates whether the function has an unpublished draft version that differs from the currently published version. Possible values: **true** - The function has an unpublished draft version. **false** - The function does not have an unpublished draft version.
idstringRequired within parentThe numeric identifier of the function.
Format: int64
languagestringRequired within parentRepresents the programming language in which this function is written. Possible values: **Deluge** - Zoho's proprietary Deluge scripting language. **Node JS** - JavaScript runtime environment (Node.js). **Java** - Java programming language. **Python** - Python programming language.
Known values: Deluge, Node JS, Java, Python
modified_byModelRequired within parentExpand Function — functions get Function — response body — functions functions item modified by
modified_timestringRequired within parentRepresents the timestamp of the last modification made to the function.
Format: date-time
namestringRequired within parentRepresents the display name of the function.
Maximum length: 100
rest_api_modearrayRequired within parentRepresents the REST API authentication modes enabled for this function.
Maximum items: 3
rest_api_mode[]stringEach itemRepresents an authentication mode identifier for REST API access to this function. Possible values: **Oauth** - OAuth-based authentication is enabled. **ZAPI** - ZAPI key-based authentication is enabled. **None** - No REST API authentication mode is enabled.
Known values: Oauth, ZAPI, None
return_typeJSONRequired within parent
return_type (anyOf 1)stringAlternativeThe data type the function returns when executed. Possible values: **bool** - Boolean return type. **collection** - Collection return type. **date** - Date return type. **float** - Floating-point number return type. **int** - Integer return type. **list** - List return type. **map** - Map return type. **string** - String return type. **void** - No return value. **null** - Return type is not explicitly set.
Known values: bool, collection, date, float, int, list, map, string, void
return_type (anyOf 2)nullAlternativeThe data type the function returns when executed. Possible values: **bool** - Boolean return type. **collection** - Collection return type. **date** - Date return type. **float** - Floating-point number return type. **int** - Integer return type. **list** - List return type. **map** - Map return type. **string** - String return type. **void** - No return value. **null** - Return type is not explicitly set.
Known values: bool, collection, date, float, int, list, map, string, void
runtimestringRequired within parentRepresents the execution runtime environment used to run this function. Possible values: **Deluge 1.0** - Deluge scripting runtime version 1.0. **NodeJS 8** - Node.js runtime version 8. **NodeJS 22** - Node.js runtime version 22. **Java 8** - Java runtime version 8. **Java 17** - Java runtime version 17. **Python 3.12** - Python runtime version 3.12.
Known values: Deluge 1.0, NodeJS 8, NodeJS 22, Java 8, Java 17, Python 3.12
sourcestringRequired within parentRepresents the origin of this function. Possible values: **crm** - The function was created within Zoho CRM. **extension** - The function originates from a Marketplace extension. **private_extension** - The function originates from a private extension.
Known values: crm, extension, private_extension
statestringRequired within parentRepresents the current lifecycle state of the function. Possible values: **active** - The function has a published version. **unpublished** - The function was created but has never been published. **deprecated** - The function is deprecated. **archived** - The function is archived. **inactive** - The function is inactive. **hibernated** - The function is hibernated.
Known values: active, unpublished, deprecated, archived, inactive, hibernated

Referenced models: Function — functions get Function — response body — functions functions item created by, Function — functions get Function — response body — functions functions item modified by, Function — functions get Function — response body — functions functions item arguments null item, Function — functions get Function — response body — functions functions item Tag item

Function — functions get Function — response body — functions functions item Tag item

FieldTypePresenceDescription and constraints
$objectRootRepresents a tag associated with a resource, including the tag name, unique identifier, and color code.
Additional keys: not allowed
color_codestringRequired within parentThe hex color code assigned to the tag for visual identification.
Format: color
idstringRequired within parentUnique identifier of the tag.
Format: int64
namestringRequired within parentThe display name of the tag.
Maximum length: 100

Function — functions get Function — response body — functions functions item arguments null item

FieldTypePresenceDescription and constraints
$objectRootRepresents a function argument definition, including the argument name and its expected data type.
Additional keys: not allowed
namestringRequired within parentThe name of the function argument.
Maximum length: 100
typestringRequired within parentThe data type of the function argument.
Maximum length: 100

Function — functions get Function — response body — functions functions item created by

FieldTypePresenceDescription and constraints
$objectRootRepresents the user who created the resource, including the user's name and ID.
Additional keys: not allowed
idstringRequired within parentThe unique ID of the user who created the function.
Format: int64
namestringRequired within parentDisplay name of the user who created the function.
Maximum length: 100

Function — functions get Function — response body — functions functions item modified by

FieldTypePresenceDescription and constraints
$objectRootRepresents the user who last modified the resource, including the user's display name and unique identifier.
Additional keys: not allowed
idstringRequired within parentRepresents the unique identifier of the user who last modified the resource.
Format: int64
namestringRequired within parentRepresents the display name of the user who last modified the resource.
Maximum length: 100

Functions — response body — functions, info

FieldTypePresenceDescription and constraints
$objectRootRepresents the successful response body containing a list of function metadata objects and pagination information.
Additional keys: not allowed
functionsarrayRequired within parentRepresents the list of function metadata objects returned in the response.
Maximum items: 200
functions[]ModelEach itemExpand Function — functions get Function — response body — functions functions item
infoModelRequired within parentExpand Functions — response body — functions, info info

Referenced models: Functions — response body — functions, info info, Function — functions get Function — response body — functions functions item

Functions — response body — functions, info info

FieldTypePresenceDescription and constraints
$objectRootPagination metadata returned with list responses, including page number, per-page count, total record count, sort details, and page tokens for cursor-based navigation.
Additional keys: not allowed
countJSONRequired within parent
count (anyOf 1)integerAlternativeThe total number of records returned in the current response.
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** - More records exist beyond the current page. **false** - No additional records exist beyond the current page.
next_page_tokenJSONRequired within parent
next_page_token (anyOf 1)stringAlternativeThe token used to retrieve the next page of results. Present when additional records are available beyond the current page.
Maximum length: 1000
next_page_token (anyOf 2)nullAlternativeThe token used to retrieve the next page of results. Present when additional records are available beyond the current page.
Maximum length: 1000
pageJSONRequired within parent
page (anyOf 1)integerAlternativeThe current page number in offset-based pagination.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
page_token_expiryJSONRequired within parent
page_token_expiry (anyOf 1)stringAlternativeRepresents the expiration timestamp of the page tokens in ISO 8601 format.
Format: date-time
page_token_expiry (anyOf 2)nullAlternativeRepresents the expiration timestamp of the page tokens in ISO 8601 format.
Format: date-time
per_pageJSONRequired within parent
per_page (anyOf 1)integerAlternativeThe maximum number of records returned per page in the response.
Format: int32
per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
previous_page_tokenJSONRequired within parent
previous_page_token (anyOf 1)stringAlternativeThe token used to retrieve the previous page of results. Present when a previous page exists.
Maximum length: 1000
previous_page_token (anyOf 2)nullAlternativeThe token used to retrieve the previous page of results. Present when a previous page exists.
Maximum length: 1000
sort_bystringRequired within parentThe field used to sort the results. Possible values: **id** - Sorts results by record ID.
Known values: id
sort_orderstringRequired within parentRepresents the direction in which results are sorted. Possible values: **asc** - Ascending order. **desc** - Descending order.
Known values: asc, desc

List Function Runtime — response body

FieldTypePresenceDescription and constraints
$objectRootThe response returned when retrieving the list of supported runtime environments.
Additional keys: not allowed
runtimesarrayRequired within parentArray of supported runtime environment entries.
Maximum items: 100
runtimes[]ModelEach itemExpand List Function Runtime — response body — runtimes item

Referenced models: List Function Runtime — response body — runtimes item

List Function Runtime — response body — runtimes item

FieldTypePresenceDescription and constraints
$objectRootSupported function runtime entry, specifying the language, runtime version, and deprecation status.
Additional keys: not allowed
deprecatedbooleanRequired within parentIndicates whether this runtime version is deprecated and should no longer be used for new functions. Possible values: **true** - The runtime version is deprecated. **false** - The runtime version is active and available for use.
languagestringRequired within parentRepresents the programming language of the runtime. Possible values: **Deluge** - Deluge scripting language. **Node JS** - Node.js runtime environment. **Java** - Java runtime environment. **Python** - Python runtime environment.
Known values: Deluge, Node JS, Java, Python
runtimestringRequired within parentThe runtime version identifier for this function entry. Possible values: **Deluge 1.0** - Deluge scripting language, version 1.0. **NodeJS 8** - Node.js runtime, version 8. **NodeJS 22** - Node.js runtime, version 22. **Java 8** - Java runtime, version 8. **Java 17** - Java runtime, version 17. **Python 3.12** - Python runtime, version 3.12.
Known values: Deluge 1.0, NodeJS 8, NodeJS 22, Java 8, Java 17, Python 3.12

Publish a function — request body — body

FieldTypePresenceDescription and constraints
$objectRootThe request body for publishing a post, containing the publish configuration.
Additional keys: not allowed
publishModelOptionalExpand Publish a function — request body — body publish
This object will be used for publish info

Referenced models: Publish a function — request body — body publish

Publish a function — request body — body publish

FieldTypePresenceDescription and constraints
$objectRootSpecify the publish configuration for the function. For **Deluge** functions, specifying this object records the changelog for the published revision. Deluge functions are published automatically regardless of whether this object is specified or not. For **Java, Node.js**, and **Python** functions, specifying this object attempts to publish the function after it is created. If this object is omitted, the function is created in the unpublished state. In that case, use the [Publish Function API](functions.yaml#$.paths./settings/functions/{fxIdentifier}/actions/publish.post) to publish the function later.
Additional keys: not allowed
changelogstring or nullOptionalChangelog message for revision tracking. For Deluge functions, recorded as part of the auto-publish. For non-Deluge functions, recorded when the publish step succeeds.
Maximum length: 250

Publish a function — request body — path

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fxIdentifierstringRequired within parentMaximum length: 255
fxIdentifier (anyOf 1)JSONAlternativeNumeric identifier of the function.
fxIdentifier (anyOf 1) (allOf 1)stringAll variants applyNumeric identifier of the function.
Format: int64
Maximum length: 19
Minimum length: 5
Pattern: ^[0-9]+$
fxIdentifier (anyOf 2)JSONAlternativeAPI name of the function.
fxIdentifier (anyOf 2) (allOf 1)stringAll variants applyAPI name of the function.
Maximum length: 100
Pattern: ^[A-Za-z][A-Za-z0-9_-]*$

Publish a function — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the successful response returned after a publish operation, containing the results of the publish action.
Additional keys: not allowed
publisharrayRequired within parentRepresents the list of results returned for the publish operation.
Maximum items: 1
publish[]ModelEach itemExpand Publish a function — response body — publish item

Referenced models: Publish a function — response body — publish item

Publish a function — response body — publish item

FieldTypePresenceDescription and constraints
$objectRootRepresents a successful result item for a standalone publish operation, including the result code, function ID, status, and message.
Additional keys: not allowed
codestringRequired within parentRepresents the result code for the operation. Possible values: **SUCCESS** - The operation completed successfully.
Known values: SUCCESS
detailsModelRequired within parentExpand Publish a function — response body — publish item details
messagestringRequired within parentRepresents the success message describing the completed operation.
Maximum length: 255
statusstringRequired within parentRepresents the overall status of the operation. Possible values: **success** - The operation completed without errors.
Known values: success

Referenced models: Publish a function — response body — publish item details

Publish a function — response body — publish item details

FieldTypePresenceDescription and constraints
$objectRootDetails object returned in success responses, containing the unique identifier of the affected resource.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the function that was created, updated, or deleted.
Format: int64

Update a function by identifier — request body — body metadata functions item

FieldTypePresenceDescription and constraints
$objectRootSchema for creating or updating a function. Contains the function metadata such as name, API name, description, runtime, category, and optional inline script code.
Additional keys: not allowed
_codestring or nullOptionalInline function script content as a string. Applicable only for Deluge runtime — Deluge functions are auto-published when this field is set. For non-Deluge runtimes (Java, NodeJS, Python), upload a ZIP code package via the `code` multipart form field instead.
Maximum length: 2097152
Minimum length: 1
api_namestring or nullOptionalThe unique programmatic identifier for the function.
Maximum length: 100
Minimum length: 3
Pattern: ^[A-Za-z][A-Za-z0-9_-]*$
categorystring or nullOptionalThe trigger category that determines how and when the function executes. Possible values: **Button** - Triggered when a user clicks a button on a record. **Automation** - Triggered by an automated Workflow or rule. **Schedule** - Triggered at a scheduled time. **Related List** - Triggered from a related list on a record. **Standalone** - Executed independently without a specific trigger context. **Signals** - Triggered by a signal event. **Validation Rule** - Triggered as part of a Validation Rule evaluation. **Dynamic** - Triggered dynamically based on runtime conditions.
One of: Button, Automation, Schedule, Related List, Standalone, Signals, Validation Rule, Dynamic
descriptionstring or nullOptionalThe description of the function's purpose and behavior.
Maximum length: 3000
namestring or nullOptionalThe display name of the function.
Maximum length: 100
Minimum length: 3
Pattern: ^[A-Za-z][A-Za-z0-9 _-]*$
runtimestring or nullOptionalThe execution runtime environment for the function. Possible values: **Deluge 1.0** - Deluge scripting language, version 1.0. **Java 8** - Java language runtime, version 8. **Java 17** - Java language runtime, version 17. **NodeJS 8** - Node.js runtime, version 8. **NodeJS 22** - Node.js runtime, version 22. **Python 3.12** - Python language runtime, version 3.12.
One of: Deluge 1.0, Java 8, Java 17, NodeJS 8, NodeJS 22, Python 3.12

Update a function by identifier — response body — functions functions item

FieldTypePresenceDescription and constraints
$objectRootRepresents a partial-success result item within a 207 multi-status response, indicating that the function draft was saved but the publish step failed due to compilation errors.
Additional keys: not allowed
codestringOptionalRepresents the operation result code for the partial-success response, indicating whether the draft save and publish steps succeeded or failed.
Maximum length: 255
detailsModelOptionalExpand Update a function by identifier — response body — functions functions item details
messagestringOptionalRepresents the message describing the outcome of the operation, indicating that the draft was saved but the publish step failed.
Maximum length: 255
statusstringOptionalRepresents the overall status of the operation, reflecting the outcome of the draft save step regardless of whether the subsequent publish step succeeded.
Maximum length: 255

Referenced models: Update a function by identifier — response body — functions functions item details

Update a function by identifier — response body — functions functions item details

FieldTypePresenceDescription and constraints
$objectRootRepresents the details returned in a 207 partial success response, including the function ID and any compilation errors that caused the publish step to fail.
Additional keys: not allowed
errorsModelOptionalExpand Update a function by identifier — response body — functions functions item details errors
idstringRequired within parentRepresents the unique identifier of the function that was created or updated.
Format: int64

Referenced models: Update a function by identifier — response body — functions functions item details errors

Update a function by identifier — response body — functions functions item details errors

FieldTypePresenceDescription and constraints
$objectRootRepresents the error response returned when a non-Deluge function's code fails to compile during a publish attempt. Contains the error code **COMPILATION_ERROR**, along with details that include the file, line, and message for each compilation error.
Additional keys: not allowed
codestringRequired within parentRepresents the error code for the response. Possible values: **COMPILATION_ERROR** - Indicates the function's code failed to compile.
Known values: COMPILATION_ERROR
detailsobjectRequired within parentRepresents the error details for the compilation failure, including the list of individual errors found in the code.
Additional keys: not allowed
details.errorsarrayRequired within parentThe list of compilation errors found in the function code.
Maximum items: 5000
details.errors[]objectEach itemRepresents a single compilation error entry, containing the file path, line number, and error message.
Additional keys: not allowed
details.errors[].filestringOptionalRelative file path within the code package where the error occurred.
Maximum length: 5000
details.errors[].lineJSONOptional
details.errors[].line (anyOf 1)integerAlternativeLine number in the source file where the error occurred.
Format: int32
details.errors[].line (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
details.errors[].messagestringRequired within parentThe description of the compilation error.
Maximum length: 5000
messagestringRequired within parentThe error message returned when a function publish operation fails due to compilation errors. Possible values: **function publish failed due to compilation errors** - Indicates that the function could not be published because the code contains compilation errors.
Known values: function publish failed due to compilation errors
statusstringRequired within parentThe status of the response when a compilation error occurs. Possible values: **error** - Indicates that the operation failed due to a compilation error.
Known values: error

Update a function by identifier — response body — functions — Putfunctions Response200

FieldTypePresenceDescription and constraints
$objectRootThe response returned after a successful function update.
Additional keys: not allowed
functionsarrayRequired within parentThe list of function update result objects returned after the operation.
Maximum items: 1
functions[]ModelEach itemExpand Function — functions delete Function — response body — functions item

Referenced models: Function — functions delete Function — response body — functions item

Update a function by identifier — response body — functions — Putfunctions Response207

FieldTypePresenceDescription and constraints
$objectRootRepresents a partial success response for a function update operation. The **functions** array contains the result details for the updated function.
Additional keys: not allowed
functionsarrayRequired within parentRepresents the list of function update results included in the partial success response.
Maximum items: 1
functions[]ModelEach itemExpand Update a function by identifier — response body — functions functions item

Referenced models: Update a function by identifier — response body — functions 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.