Zoho: Automation Task — workflow Tasks delete Task By Id

← Workflow tasks operations · Get started

Operation zoho.deletetaskbyid

Provider route: DELETE /crm/v8/settings/automation/tasks/{id}. 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"]["deleteTaskById"]>[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.deleteTaskById(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_task_by_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Maximum length: 20

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 Automation Task — workflow Tasks delete Task By Id — response body

Referenced models: Automation Task — workflow Tasks delete Task By Id — response body

Schemas

Automation Task — workflow Tasks delete Task By Id — response body

Field	Type	Presence	Description and constraints
$	object	Root	Single-task delete success response. Additional keys: not allowed
tasks	array	Required within parent	Contains one success result object for the deleted task. Maximum items: 1 Minimum items: 1
tasks[]	Model	Each item	Expand Create an Automation Task — response body — tasks item

Referenced models: Create an Automation Task — response body — tasks item

Create an Automation Task — response body — tasks item

Field	Type	Presence	Description and constraints
$	object	Root	Result of a task create, update, or delete operation. Additional keys: not allowed
code	string	Required within parent	Operation result code (e.g., SUCCESS). Maximum length: 255
details	Model	Required within parent	Expand Create an Automation Task — response body — tasks item details
message	string	Required within parent	Result message describing the outcome of the task action. Maximum length: 255
status	string	Required within parent	Operation result status (e.g., success). Maximum length: 255

Referenced models: Create an Automation Task — response body — tasks item details

Create an Automation Task — response body — tasks item details

Field	Type	Presence	Description and constraints
$	object	Root	Details returned with a task action result, including the created or affected resource ID. Additional keys: not allowed
id	string	Required within parent	Unique ID of the created or affected automation task. Maximum length: 20
resource_path_index	string	Optional	Index of the resource in the request payload array. Maximum length: 255

Policy, approvals and errors

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