Zoho: Delete records from a specified module

← Record operations · Get started

Operation zoho.deleterecords

Provider route: DELETE /crm/v8/{module}. 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["record"]["deleteRecords"]>[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.record.deleteRecords(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.record.delete_records(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.module	string	Required within parent	Maximum length: 25
query	object	Optional	Additional keys: not allowed
query.ids	array	Optional	Minimum items: 1 Unique items: true
query.ids[]	string	Each item	Unique record ID in int64 string format. Format: int64

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)	Model	Alternative	Expand Delete records from a specified module — response body — data — Record Delete Success Response
$ (anyOf 2)	Model	Alternative	Expand Delete records from a specified module — response body — data — Record Delete Multi Status Response

Referenced models: Delete records from a specified module — response body — data — Record Delete Multi Status Response, Delete records from a specified module — response body — data — Record Delete Success Response

Schemas

Delete records from a specified module — response body — data — Record Delete Multi Status Response

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response schema for the record delete multi status operation. Additional keys: not allowed
data	array	Required within parent	Represents the data value. Maximum items: 100 Minimum items: 2
data[]	JSON	Each item	Represents a single item in the RecordDeleteMultiStatusResponse array.
data[] (anyOf 1)	object	Alternative	Represents the response schema for the record delete multi status operation. Additional keys: not allowed
data[] (anyOf 1).code	string	Required within parent	Represents the data value. Known values: SUCCESS
data[] (anyOf 1).details	object	Required within parent	Represents the data value. Additional keys: not allowed
data[] (anyOf 1).details.id	string	Required within parent	Represents the data value. Format: int64
data[] (anyOf 1).message	string	Required within parent	Represents the data value.
data[] (anyOf 1).status	string	Required within parent	Represents the data value. Known values: success
data[] (anyOf 2)	Model	Alternative	Expand Delete records from a specified module — response body — data / data / item / code: INVALID DATA, status: error
data[] (anyOf 3)	Model	Alternative	Expand Delete records from a specified module — response body — data / data / item / code: REQUIRED PARAM MISSING, status: error
data (allOf 1)	JSON	All variants apply	Represents the response schema for the record delete multi status operation.
data (allOf 2)	JSON	All variants apply	Represents the response schema for the record delete multi status operation.

Referenced models: Delete records from a specified module — response body — data / data / item / code: INVALID DATA, status: error, Delete records from a specified module — response body — data / data / item / code: REQUIRED PARAM MISSING, status: error

Delete records from a specified module — response body — data — Record Delete Success Response

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response schema for the record delete success operation. Additional keys: not allowed
data	array	Required within parent	Represents the data value. Maximum items: 100 Minimum items: 1
data[]	object	Each item	Represents a single item in the RecordDeleteSuccessResponse array. Additional keys: not allowed
data[].code	string	Required within parent	Represents the data value. Known values: SUCCESS
data[].details	object	Required within parent	Represents the data value. Additional keys: not allowed
data[].details.id	string	Required within parent	Represents the data value. Format: int64
data[].message	string	Required within parent	Represents the data value. Known values: record deleted
data[].status	string	Required within parent	Represents the data value. Known values: success

Delete records from a specified module — response body — data / data / item / code: INVALID DATA, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single record delete invalid data result item. Additional keys: not allowed
code	string	Required within parent	Represents the error code identifying the type of failure. Known values: INVALID_DATA
details	object	Required within parent	Contains additional context about the error. Additional keys: not allowed
details.id	string	Required within parent	Contains additional context about the error. Format: int64 Maximum length: 20
message	string	Required within parent	Represents the error message describing why the operation failed.
status	string	Required within parent	Indicates the overall result status of the request. Known values: error

Delete records from a specified module — response body — data / data / item / code: REQUIRED PARAM MISSING, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single record delete required parameter missing result item. Additional keys: not allowed
code	string	Required within parent	Represents the error code identifying the type of failure. Known values: REQUIRED_PARAM_MISSING
details	object	Required within parent	Contains additional context about the error. Additional keys: not allowed
details.param_name	string	Required within parent	Contains additional context about the error. Maximum length: 255
message	string	Required within parent	Represents the error message describing why the operation failed.
status	string	Required within parent	Indicates the overall result status of the request. Known values: error

Policy, approvals and errors

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