Zoho: Mass Delete Tags Status

← Mass delete tags operations · Get started

Operation zoho.getmassdeletetagsstatus

Provider route: GET /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"]["getMassDeleteTagsStatus"]>[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.getMassDeleteTagsStatus(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.get_mass_delete_tags_status(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.job_id	string	Required within parent	Format: int64 Maximum length: 19

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 status payload returned for the queried mass delete tag job, including the job identifier, current execution state, scheduled time, and counts of total, deleted, and failed tags. Additional keys: not allowed
mass_delete	array	Required within parent	Represents the list of mass delete tag jobs returned for the queried job ID, with one entry per job. Maximum items: 100
mass_delete[]	object	Each item	Each object represents a single mass delete tag job, including its identifier, current status, and tag deletion counts. Additional keys: not allowed
mass_delete[].created_time	string	Optional	Represents the timestamp at which the mass delete tag job was scheduled, in ISO 8601 format. Format: date-time
mass_delete[].deleted_count	JSON	Optional
mass_delete[].deleted_count (anyOf 1)	integer	Alternative	Represents the number of tags that the job has deleted successfully. Format: int32 Minimum: 0
mass_delete[].deleted_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
mass_delete[].failed_count	JSON	Optional
mass_delete[].failed_count (anyOf 1)	integer	Alternative	Represents the number of tags that the job failed to delete. Format: int32 Minimum: 0
mass_delete[].failed_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
mass_delete[].job_id	string	Required within parent	Represents the unique identifier of the mass delete tag job scheduled through the [Mass Delete Tags API](mass_delete_tags.yaml#$.paths./settings/tags/actions/mass_delete.post). Maximum length: 50
mass_delete[].status	string	Required within parent	Represents the current execution state of the mass delete tag job. Possible values: COMPLETED - The job has finished processing all tags. SCHEDULED - The job is queued and waiting to begin processing. FAILED - The job ended without completing the deletion. Maximum length: 20
mass_delete[].total_count	JSON	Optional
mass_delete[].total_count (anyOf 1)	integer	Alternative	Represents the total number of tags that were submitted for deletion in the mass delete tag job. Format: int32 Minimum: 0
mass_delete[].total_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

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