Zoho CRM: Locking Informations Lock Record

Lock a Zoho CRM record against edits, with a reason.

Tool ID: zoho_crm_locking_informations_lock_record

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_locking_informations_lock_record',
  {
    "recordId": "record_123",
    "moduleName": "Example",
    "data": [
      {
        "Locked_Reason__s": "example"
      }
    ]
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute zoho_crm_locking_informations_lock_record --input '{
  "recordId": "record_123",
  "moduleName": "Example",
  "data": [
    {
      "Locked_Reason__s": "example"
    }
  ]
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "data": [
      {
        "status": "success",
        "code": "SUCCESS",
        "message": "Example message",
        "details": {}
      }
    ]
  }
}

Use deepline describe zoho_crm_locking_informations_lock_record --json for the latest machine-readable contract.

Input reference

A JSON object containing the reason for locking the record.

Name	Type	Required	Default	Details
`payload.recordId`	`string`	Yes	—	The ID of the record from which the lock is to be removed. Maximum length: 32.
`payload.moduleName`	`string`	Yes	—	The API name of the module to which the locked record belongs. Maximum length: 256.
`payload.data`	`array`	Yes	—	An array containing the reason for locking the record. Maximum items: 1.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	A JSON object containing the success response for locking the record.
`result.data.data`	`array`	Yes	—	An array containing the success response for locking the record. Maximum items: 1.
`result.data.data[].status`	`"success"`	Yes	—	Indicates the success status of the lock operation. Allowed: `success`.
`result.data.data[].code`	`"SUCCESS"`	Yes	—	A code representing the successful lock operation. Allowed: `SUCCESS`.
`result.data.data[].message`	`string`	Yes	—	A message providing additional information about the lock operation. Maximum length: 255.
`result.data.data[].details`	`record`	Yes	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation