Zoho: Mass delete tags

← Mass delete tags operations · Get started

Operation zoho.massdeletetags

Provider route: POST /crm/v8/settings/tags/actions/mass_delete. 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["massDeleteTags"]["massDeleteTags"]>[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.massDeleteTags.massDeleteTags(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.mass_delete_tags.mass_delete_tags(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Required within parent	Represents the request payload for scheduling a mass delete tag job, containing the target module and the tags to delete. Additional keys: not allowed
body.mass_delete	array	Required within parent	Specify the list of mass delete tag jobs. Each entry identifies the module and the tags to delete in that module within a single job. Maximum items: 100
body.mass_delete[]	object	Each item	Each object specifies the module and the tags to delete in that module for one mass delete tag job. Additional keys: not allowed
body.mass_delete[].module	object	Required within parent	Specify the module from which the tags must be deleted, identified by its unique ID and API name. Additional keys: not allowed
body.mass_delete[].module.api_name	string	Required within parent	Specify the API name of the module from which the tags must be deleted. Maximum length: 50
body.mass_delete[].module.id	string	Required within parent	Specify the unique ID of the module from which the tags must be deleted. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get the valid values. Maximum length: 50
body.mass_delete[].tags	array	Required within parent	Specify the tags to delete from the module. Each entry identifies a single tag by its unique ID. Use the [Get Tags API](tags.yaml#$./settings/tags.get) to get the valid ID. Maximum items: 100
body.mass_delete[].tags[]	object	Each item	Each object specifies a tag to delete from the module. Additional keys: not allowed
body.mass_delete[].tags[].id	string	Required within parent	Specify the unique ID of the tag to delete. Maximum length: 255
body.mass_delete[].tags[].name	string	Optional	Specify the name of the tag to delete. Maximum length: 50

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
$	object	Root	Represents the response payload returned when a mass delete tag job is scheduled successfully, including the job identifier and the schedule code. Additional keys: not allowed
code	string	Required within parent	Represents the code that identifies the result of scheduling the mass delete tag job. For a successful schedule, the value is SCHEDULED. Maximum length: 10
details	object	Required within parent	Represents the details of the scheduled mass delete tag job, including the job identifier returned by the system. Additional keys: not allowed
details.job_id	string	Required within parent	Represents the unique identifier assigned to the scheduled mass delete tag job. Use this value with the [Mass Delete Tags Status](mass_delete_tags.yaml#$.paths./settings/tags/actions/mass_delete.get) API call to know the job state. Maximum length: 50
message	string	Required within parent	Represents the message that describes the outcome of scheduling the mass delete tag job. Maximum length: 200
status	string	Required within parent	Represents the status of the API call. For a scheduled job, the value is success. Maximum length: 20

Policy, approvals and errors

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