> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: Locking Informations Lock Record

> Lock a Zoho CRM record against edits, with a reason. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

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

> [!NOTE]
>
> 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "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. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "A JSON object containing the reason for locking the record.",
    "properties": {
      "recordId": {
        "type": "string",
        "description": "The ID of the record from which the lock is to be removed.",
        "maxLength": 32
      },
      "moduleName": {
        "type": "string",
        "description": "The API name of the module to which the locked record belongs.",
        "maxLength": 256
      },
      "data": {
        "type": "array",
        "description": "An array containing the reason for locking the record.",
        "maxItems": 1,
        "items": {
          "type": "object",
          "description": "An object containing the reason for locking the record.",
          "properties": {
            "Locked_Reason__s": {
              "type": "string",
              "description": "The reason for locking the record.",
              "maxLength": 3000
            }
          },
          "required": [
            "Locked_Reason__s"
          ],
          "additionalProperties": false
        }
      }
    },
    "required": [
      "recordId",
      "moduleName",
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "A JSON object containing the success response for locking the record.",
        "properties": {
          "data": {
            "type": "array",
            "description": "An array containing the success response for locking the record.",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "An object containing the success response for locking the record.",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Indicates the success status of the lock operation.",
                  "enum": [
                    "success"
                  ]
                },
                "code": {
                  "type": "string",
                  "description": "A code representing the successful lock operation.",
                  "enum": [
                    "SUCCESS"
                  ]
                },
                "message": {
                  "type": "string",
                  "description": "A message providing additional information about the lock operation.",
                  "maxLength": 255
                },
                "details": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "required": [
                "status",
                "code",
                "message",
                "details"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "data"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.