Zoho: Update locking reason of a locked record

← Locking informations operations · Get started

Operation zoho.updatereasonoflockedrecord

Provider route: PUT /crm/v8/{moduleName}/{recordId}/Locking_Information__s/{lockId}. 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["lockingInformations"]["updateReasonofLockedRecord"]>[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.lockingInformations.updateReasonofLockedRecord(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.locking_informations.update_reasonof_locked_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.moduleName	string	Required within parent	Maximum length: 255
path.recordId	string	Required within parent	Maximum length: 32
path.lockId	string	Required within parent	Maximum length: 32
body	object	Required within parent	The request body must contain a data array with one object specifying the updated locking reason. Additional keys: not allowed
body.data	array	Required within parent	Specify the locking information details for the record. Maximum items: 1
body.data[]	object	Each item	Specify the locking details for the record. Additional keys: not allowed
body.data[].Locked_Reason__s	string	Required within parent	Specify the reason for locking the record. Maximum length: 3000

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	Contains the success response for the lock reason update operation. Additional keys: not allowed
data	array	Required within parent	Contains the response details for the update operation. Maximum items: 1
data[]	object	Each item	Represents the result of the lock reason update operation. Additional keys: not allowed
data[].code	string	Required within parent	Represents the response code for the update operation. Known values: SUCCESS
data[].details	JSON	Required within parent	Contains the details of the successfully updated locked record, including its unique identifier and audit timestamps.
data[].details (anyOf 1)	object	Alternative	Contains the success response for the lock reason update operation. Additional keys: not allowed
data[].details (anyOf 1).Created_By	object	Optional	Contains the details of the successfully updateed record. Additional keys: not allowed
data[].details (anyOf 1).Created_By.id	string	Required within parent	Contains the details of the successfully updateed record. Maximum length: 255
data[].details (anyOf 1).Created_By.name	string	Required within parent	Contains the details of the successfully updateed record. Maximum length: 255
data[].details (anyOf 1).Created_Time	string	Optional	Contains the details of the successfully updateed record. Format: date-time
data[].details (anyOf 1).Modified_By	object	Optional	Contains the details of the successfully updateed record. Additional keys: not allowed
data[].details (anyOf 1).Modified_By.id	string	Required within parent	Contains the details of the successfully updateed record. Maximum length: 255
data[].details (anyOf 1).Modified_By.name	string	Required within parent	Contains the details of the successfully updateed record. Maximum length: 255
data[].details (anyOf 1).Modified_Time	string	Optional	Contains the details of the successfully updateed record. Format: date-time
data[].details (anyOf 1).id	string	Required within parent	Contains the details of the successfully updateed record. Maximum length: 255
data[].details (anyOf 2)	object	Alternative	Contains the success response for the lock reason update operation. Additional keys: not allowed
data[].details (anyOf 2).id	string	Required within parent	Contains the details of the successfully updateed record. Maximum length: 255
data[].message	string	Required within parent	Represents the response message for the update operation. Maximum length: 255
data[].status	string	Required within parent	Represents the status of the update operation. Known values: success

Policy, approvals and errors

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