Zoho: Delete a recycle-bin record permanently

← Recycle bin operations · Get started

Operation zoho.deleterecyclebinrecord

Provider route: DELETE /crm/v8/settings/recycle_bin/{recordId}. 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"]["deleteRecycleBinRecord"]>[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.deleteRecycleBinRecord(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.delete_recycle_bin_record(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.recordId	string	Required within parent	Identifier Maximum length: 100

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 for a successful permanent deletion of a single recycle-bin record, containing the per-item result under the recycle_bin array. Additional keys: not allowed
recycle_bin	array	Required within parent	Represents the list of per-item results for the deletion request, with one entry for the single deleted record. Maximum items: 200
recycle_bin[]	object	Each item	Represents the per-item outcome for a single recycle-bin record deletion, including the outcome status, result code, message, and deletion details. Additional keys: not allowed
recycle_bin[].code	string	Required within parent	Represents the result code for the deletion. Possible values: SUCCESS - The record was permanently deleted. CANNOT_DELETE - The record could not be permanently deleted. Known values: SUCCESS, CANNOT_DELETE
recycle_bin[].details	object	Required within parent	Represents additional details about the per-item deletion result, including the ID of the affected record. Additional keys: allowed
recycle_bin[].details.id	string	Required within parent	Represents the unique identifier of the recycle-bin record that was permanently deleted. Maximum length: 500
recycle_bin[].message	string	Required within parent	Represents the message describing the outcome of the deletion request. Maximum length: 500
recycle_bin[].status	string	Required within parent	Indicates whether the deletion succeeded or failed for the record. Possible values: success - The record was permanently deleted. error - The deletion failed for this record. Known values: success, error

Policy, approvals and errors

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