Zoho: Delete record locking configuration

← Record locking configurations operations · Get started

Operation zoho.deleterecordlockingconfiguration

Provider route: DELETE /crm/v8/settings/record_locking_configurations. 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["recordLockingConfigurations"]["deleteRecordLockingConfiguration"]>[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.recordLockingConfigurations.deleteRecordLockingConfiguration(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_locking_configurations.delete_record_locking_configuration(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.module	string	Required within parent	Module API name. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module names. Maximum length: 256
query.ids	string	Required within parent	Comma-separated IDs of the configurations to delete. Maximum length: 256

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	Response object for a successful deletion. Additional keys: not allowed
record_locking_configurations	array	Required within parent	Array containing details of the deleted configuration(s). Maximum items: 1
record_locking_configurations[]	object	Each item	Details of a deleted configuration. Additional keys: not allowed
record_locking_configurations[].code	string	Required within parent	Success code for the operation. Known values: SUCCESS Maximum length: 256
record_locking_configurations[].details	object	Required within parent	Additional details about the deleted configuration. Additional keys: not allowed
record_locking_configurations[].details.id	string	Required within parent	ID of the deleted configuration. Maximum length: 256
record_locking_configurations[].message	string	Required within parent	Informational message about the deletion. Maximum length: 256
record_locking_configurations[].status	string	Required within parent	Indicates successful deletion. Known values: success Maximum length: 256

Policy, approvals and errors

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