Zoho: Update Automation Function — automation Functions put Automation Functions
Zoho automationFunctions.putAutomationFunctions: arguments, response, policy and SDK examples.
← Automation functions operations · Get started
Operation zoho.putautomationfunctions
Provider route: PUT /crm/v8/settings/automation/functions/{functionId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["putAutomationFunctions"]>[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.putAutomationFunctions(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.put_automation_functions(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.functionId | string | Required within parent | Format: int64 Maximum length: 255 |
body | Model | Optional | Expand Update Automation Function — automation Functions put Automation Functions — request body — body |
Referenced models: Update Automation Function — automation Functions put Automation Functions — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Update Automation Function — automation Functions put Automation Functions — response body |
Referenced models: Update Automation Function — automation Functions put Automation Functions — response body
Schemas
Section titled “Schemas”Update Automation Function — automation Functions put Automation Functions — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request payload for modifying one or more automation functions in a batch operation. Additional keys: not allowed |
functions | array | Required within parent | Represents the list of automation function change sets included in the modification request. Maximum items: 1 |
functions[] | Model | Each item | Expand 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 — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned after submitting automation function modifications, containing per-item results for each submitted function. Additional keys: not allowed |
functions | array | Required within parent | Represents the list of per-item results for each automation function modification submitted in the request. Maximum items: 1 |
functions[] | Model | Each item | Expand Create Automation Function — response body — functions item |
Referenced models: Create Automation Function — response body — functions item
Update Automation Function — automation Functions put Automation Functions — request body — body functions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an automation function modification request, including the feature type, target module, arguments, and the function ID to update. Additional keys: not allowed |
arguments | array | Optional | Represents the list of arguments configured for the automation function. Maximum items: 50 |
arguments[] | Model | Each item | Expand Create Automation Function — request body — body functions item arguments item |
feature_type | string | Optional | The 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 |
id | string | Required within parent | Represents the unique identifier of the automation function to update. Format: int64 Maximum length: 18 |
module | Model | Optional | Expand Create Automation Function — request body — body functions item module Module Datas |
related_module | Model | Optional | Expand 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
Create Automation Function — response body — functions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the result of processing an automation function action, including a status code, message, and associated details. Additional keys: not allowed |
code | string | Required within parent | The status code indicating the outcome of the automation function action. Possible values: **SUCCESS** - The automation function action was processed successfully. Known values: SUCCESS |
details | Model | Required within parent | Expand Create Automation Function — response body — functions item details |
message | string | Required within parent | The message describing the result of the operation. Maximum length: 255 |
status | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents name, type and value that defines a single argument passed to an automation function. Additional keys: not allowed |
name | string | Required within parent | Represents the name of the automation function argument. Maximum length: 100 |
type | string | Required within parent | The 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 |
value | string | Required within parent | Represents the value assigned to the automation function argument. Maximum length: 1000 |
Create Automation Function — request body — body functions item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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_name | string | Optional | Represents the API name of the module. Maximum length: 5 |
id | string | Optional | Represents the unique ID of the module. Format: int64 Maximum length: 18 |
Create Automation Function — response body — functions item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Operation details for a processed automation function, including the resulting resource identifier. Additional keys: not allowed |
id | string | Required within parent | The unique identifier of the automation function that was processed. Format: int64 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.putautomationfunctions. Catalog operation: putAutomationFunctions. 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.