Zoho: Delete One or More Workflow Rules

← Workflow rules operations · Get started

Operation zoho.deleteworkflowrules

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

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["workflowRules"]["deleteWorkflowRules"]>[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.workflowRules.deleteWorkflowRules(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.workflow_rules.delete_workflow_rules(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.ids	string	Required within parent	Format: string

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
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Update Workflow Rule by ID — response body
$ (anyOf 2)	object	Alternative	Wrapped error response with workflow_rules Additional keys: not allowed
$ (anyOf 2).workflow_rules	array	Required within parent	Array of error objects Maximum items: 10
$ (anyOf 2).workflow_rules[]	JSON	Each item
$ (anyOf 2).workflow_rules[] (anyOf 1)	Model	Alternative	Expand Delete One or More Workflow Rules — response body — Wrapped error response with workflow_rules / workflow_rules / item / status: error
$ (anyOf 2).workflow_rules[] (anyOf 2)	Model	Alternative	Expand Update Workflow Rule Execution Order for Module — response body — reorder item

Referenced models: Delete One or More Workflow Rules — response body — Wrapped error response with workflow_rules / workflow_rules / item / status: error, Update Workflow Rule Execution Order for Module — response body — reorder item, Update Workflow Rule by ID — response body

Schemas

Delete One or More Workflow Rules — response body — Wrapped error response with workflow_rules / workflow_rules / item / status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error response returned when a required parameter such as the module API name or field path is missing from the request. Additional keys: not allowed
code	string	Required within parent	Represents the error code that identifies the specific error condition. Known values: REQUIRED_PARAM_MISSING, INVALID_DATA, NOT_ALLOWED, INVALID_MODULE, INVALID_REQUEST, INVALID_REQUEST_METHOD, AUTHENTICATION_FAILURE, PATTERN_NOT_MATCHED, JSON_PARSE_ERROR
details	object	Required within parent	Represents the error details containing additional context about the failed request. Additional keys: not allowed
details.api_name	string	Optional	Represents the API name of the field or parameter that caused the validation error. Maximum length: 255
details.expected_data_type	string	Optional	Represents the **expected_data_type** value from the error detail object. Maximum length: 255
details.id	string	Optional	Represents the **ID** value from the error detail object. Maximum length: 20
details.maximum_length	JSON	Optional
details.maximum_length (anyOf 1)	integer	Alternative	Represents the **maximum_length** value from the error detail object. Format: int32
details.maximum_length (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
details.param_name	string	Optional	Represents the **param_name** value from the error detail object. Known values: ids, module, executed_from, executed_till, execute_on, sort_order, sort_by
message	string	Required within parent	Represents the error message describing the issue. Maximum length: 1000
status	string	Required within parent	Represents the response status for the error, typically **error**. Known values: error

Update Workflow Rule Execution Order for Module — response body — reorder item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single item in a multi-status response array, including a response code, status indicator, message, and optionally the resource details. Additional keys: not allowed
code	string	Optional	Represents the API response code indicating the operation result, such as **SUCCESS** or **INVALID_DATA**. Maximum length: 255
details	Model	Optional	Expand Update Workflow Rule Execution Order for Module — response body — reorder item details
message	string	Optional	Represents the message describing the operation result or error. Known values: workflow created, workflow updated, workflow deleted, WorkFlow Rule deleted successfully, rules reordered successfully, Workflow cloned successfully
status	string	Optional	Represents the response status indicator, such as **success** or **error**. Maximum length: 7

Referenced models: Update Workflow Rule Execution Order for Module — response body — reorder item details

Update Workflow Rule by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response returned after creating a workflow rule, containing the result details of the created rule. Additional keys: not allowed
workflow_rules	array	Optional	Represents the array of workflow rule objects returned in the success response. Maximum items: 200
workflow_rules[]	Model	Each item	Expand Update Workflow Rule Execution Order for Module — response body — reorder item

Referenced models: Update Workflow Rule Execution Order for Module — response body — reorder item

Update Workflow Rule Execution Order for Module — response body — reorder item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details object within a success response, containing the unique ID of the created or updated resource. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the SuccessResponseDetails within the workflow rule. Maximum length: 255

Policy, approvals and errors

SDK function policy ID: zoho.deleteworkflowrules. Catalog operation: deleteWorkflowRules. 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