Zoho: Delete automation task definitions by I Ds (bulk)

← Workflow tasks operations · Get started

Operation zoho.deletetasks

Provider route: DELETE /crm/v8/settings/automation/tasks. 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["workflowTasks"]["deleteTasks"]>[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.workflowTasks.deleteTasks(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_tasks.delete_tasks(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	Maximum length: 255 Pattern: ^[0-9]{1,20}(,[0-9]{1,20}){0,9}$

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 Delete automation task definitions by I Ds (bulk) — response body — tasks — Bulk Delete Tasks Success Response
$ (anyOf 2)	Model	Alternative	Expand Delete automation task definitions by I Ds (bulk) — response body — tasks — Bulk Delete Tasks Mixed Response

Referenced models: Delete automation task definitions by I Ds (bulk) — response body — tasks — Bulk Delete Tasks Mixed Response, Delete automation task definitions by I Ds (bulk) — response body — tasks — Bulk Delete Tasks Success Response

Schemas

Delete automation task definitions by I Ds (bulk) — response body — tasks — Bulk Delete Tasks Mixed Response

Field	Type	Presence	Description and constraints
$	object	Root	Bulk delete partial-success response. Contains mixed success and failure items for the requested task IDs. Additional keys: not allowed
tasks	array	Required within parent	Per-ID deletion results for the bulk request. Maximum items: 10
tasks[]	JSON	Each item	Represents a single per-ID outcome entry returned in a bulk DELETE request, indicating either a successful delete or a per-ID failure reason.
tasks[] (anyOf 1)	Model	Alternative	Expand Delete automation task definitions by I Ds (bulk) — response body — tasks tasks item
tasks[] (anyOf 2)	Model	Alternative	Expand Delete automation task definitions by IDs (bulk) — response body — tasks / tasks / item / code: INVALID DATA, NOT ALLOWED, status: error

Referenced models: Delete automation task definitions by IDs (bulk) — response body — tasks / tasks / item / code: INVALID DATA, NOT ALLOWED, status: error, Delete automation task definitions by I Ds (bulk) — response body — tasks tasks item

Delete automation task definitions by I Ds (bulk) — response body — tasks — Bulk Delete Tasks Success Response

Field	Type	Presence	Description and constraints
$	object	Root	Bulk delete success response. All requested task IDs were deleted successfully. Additional keys: not allowed
tasks	array	Required within parent	Deletion result entries for each requested task ID. Maximum items: 10
tasks[]	Model	Each item	Expand Delete automation task definitions by I Ds (bulk) — response body — tasks tasks item

Referenced models: Delete automation task definitions by I Ds (bulk) — response body — tasks tasks item

Delete automation task definitions by IDs (bulk) — response body — tasks / tasks / item / code: INVALID DATA, NOT ALLOWED, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Result item for a task ID that failed during bulk delete. Code is INVALID_DATA when the ID does not exist, or NOT_ALLOWED when the task is associated with a rule/blueprint or is read-only. Additional keys: not allowed
code	string	Required within parent	Failure code. Known values: INVALID_DATA, NOT_ALLOWED
details	object	Required within parent	Contains the failed task ID. Additional keys: not allowed
details.id	string	Required within parent	ID of the task that could not be deleted. Maximum length: 20
message	string	Required within parent	Failure message. Maximum length: 255
status	string	Required within parent	Operation status. Known values: error

Delete automation task definitions by I Ds (bulk) — response body — tasks tasks item

Field	Type	Presence	Description and constraints
$	object	Root	Result item for a task ID that was deleted successfully in a bulk delete operation. Additional keys: not allowed
code	string	Required within parent	Result code. Known values: SUCCESS
details	object	Required within parent	Contains the deleted task ID. Additional keys: not allowed
details.id	string	Required within parent	Unique ID of the deleted task. Maximum length: 20
message	string	Required within parent	Success message. Maximum length: 255
status	string	Required within parent	Operation status. Known values: success

Policy, approvals and errors

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