Zoho: Empty the Recycle Bin

← Recycle bin operations · Get started

Operation zoho.emptyrecyclebin

Provider route: POST /crm/v8/settings/recycle_bin/actions/empty. 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["recycleBin"]["emptyRecycleBin"]>[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.recycleBin.emptyRecycleBin(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.recycle_bin.empty_recycle_bin(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed

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)	object	Alternative	Represents the success payload returned when Zoho CRM deletes every record in the Recycle Bin immediately in a single synchronous call. Additional keys: not allowed
$ (anyOf 1).code	string	Required within parent	Represents the result code for the empty operation. Possible values: SUCCESS - Every record in the Recycle Bin was permanently deleted. Known values: SUCCESS Maximum length: 100
$ (anyOf 1).details	object	Required within parent	Represents additional details about the empty operation. This is an empty object when the operation completes successfully. Additional keys: allowed
$ (anyOf 1).message	string	Required within parent	Represents the message confirming that the Recycle Bin was emptied. Maximum length: 500
$ (anyOf 1).status	string	Required within parent	Indicates the outcome of the empty operation. Possible values: success - Every record in the Recycle Bin was permanently deleted. Known values: success
$ (anyOf 2)	object	Alternative	Represents the accepted payload returned when the empty Recycle Bin action is scheduled as a background job. Additional keys: not allowed
$ (anyOf 2).code	string	Required within parent	Represents the result code indicating that the empty operation is scheduled as a background job. Possible values: SCHEDULED - The empty Recycle Bin action was queued as a background job. Known values: SCHEDULED Maximum length: 100
$ (anyOf 2).details	object	Required within parent	Represents additional details about the scheduled empty operation. This is an empty object when the job is queued. Additional keys: allowed
$ (anyOf 2).message	string	Required within parent	Represents the message confirming that the empty Recycle Bin action has been scheduled as a background job. Maximum length: 500
$ (anyOf 2).status	string	Required within parent	Indicates the outcome of the scheduling request. Possible values: success - The empty Recycle Bin action was accepted and queued as a background job. Known values: success

Policy, approvals and errors

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