Zoho: Delink a related record

← Related records operations · Get started

Operation zoho.delinkspecificrelatedrecord

Provider route: DELETE /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}/{record}. 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["relatedRecords"]["delinkSpecificRelatedRecord"]>[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.relatedRecords.delinkSpecificRelatedRecord(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.related_records.delink_specific_related_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.parentRecordModule	string	Required within parent	Maximum length: 100 Pattern: ^[A-Za-z_][A-Za-z0-9_]*$
path.parentRecord	string	Required within parent	Maximum length: 20 Pattern: ^[0-9]+$
path.relatedList	string	Required within parent	Maximum length: 100 Pattern: ^[A-Za-z_][A-Za-z0-9_]*$
path.record	string	Required within parent	Maximum length: 20 Pattern: ^[0-9]+$

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
$	Model	Root	Expand Delink a related record — response body

Referenced models: Delink a related record — response body

Schemas

Delink a related record — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response structure for bulk operations, containing per-record result codes and operation details. Additional keys: not allowed
data	array	Required within parent	Array of operation results per record. Maximum items: 100
data[]	object	Each item	Individual operation result. Additional keys: not allowed
data[].code	string	Required within parent	Result code for the operation. Known values: SUCCESS, INVALID_DATA, DUPLICATE_DATA, MANDATORY_NOT_FOUND
data[].details	Model	Optional	Expand Delink a related record — response body — data item details
data[].message	string	Optional	Represents the operation result message for the record. Maximum length: 500
data[].status	string	Required within parent	Operation status. Known values: success, error

Referenced models: Delink a related record — response body — data item details

Delink a related record — response body — data item details

Field	Type	Presence	Description and constraints
$	object	Root	Operation details including affected record ID. Additional keys: allowed
api_name	string	Optional	API name of the field that caused the error (if applicable). Maximum length: 100
id	string	Optional	ID of the affected record. Maximum length: 20 Pattern: ^[0-9]+$
json_path	string	Optional	JSONPath to the field in request payload (if applicable). Maximum length: 500
param_name	string	Optional	Parameter name that caused the error (if applicable). Maximum length: 100

Policy, approvals and errors

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