Skip to content

Zoho: Create Automation Function

Zoho automationFunctions.postAutomationFunctions: arguments, response, policy and SDK examples.

← Automation functions operations · Get started

Operation zoho.postautomationfunctions

Provider route: POST /crm/v8/settings/automation/functions. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";
async function execute(input: Parameters<ZohoIntegration["automationFunctions"]["postAutomationFunctions"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.automationFunctions.postAutomationFunctions(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.automation_functions.post_automation_functions(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand Create Automation Function — request body — body

Referenced models: Create Automation Function — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create Automation Function — response body

Referenced models: Create Automation Function — response body

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 — 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 — 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 — 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 — 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 — 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

SDK function policy ID: zoho.postautomationfunctions. Catalog operation: postAutomationFunctions. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

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.