> ## 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: Record Locking Configurations Create Record Locking Configuration

> Set up automatic record locking for a Zoho CRM module, choosing when records lock and who can edit them. Includes SDK V2 examples, schemas, and cost.

Set up automatic record locking for a Zoho CRM module, choosing when records lock and who can edit them.

> [!NOTE]
>
> Tool ID: `zoho_crm_record_locking_configurations_create_record_locking_configuration`

## 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_record_locking_configurations_create_record_locking_configuration',
  {
    "module": "example",
    "record_locking_configurations": [
      {
        "lock_type": "automatic"
      }
    ]
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_record_locking_configurations_create_record_locking_configuration --input '{
  "module": "example",
  "record_locking_configurations": [
    {
      "lock_type": "automatic"
    }
  ]
}' --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": {
    "record_locking_configurations": [
      {
        "status": "success",
        "code": "SUCCESS",
        "message": "Example message",
        "details": {
          "id": "id_123"
        }
      }
    ]
  }
}
```

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

## Input reference

Request object for creating of record locking configuration.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.module` | `string` | Yes | — | The API name of the module for which the record locking configuration is to be retrieved. Maximum length: 256. |
| `payload.record_locking_configurations` | `array` | Yes | — | details of record\_locking\_configurations Maximum items: 1. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Request object for creating of record locking configuration.",
    "properties": {
      "module": {
        "type": "string",
        "description": "The API name of the module for which the record locking configuration is to be retrieved.",
        "maxLength": 256
      },
      "record_locking_configurations": {
        "type": "array",
        "description": "details of record_locking_configurations",
        "maxItems": 1,
        "items": {
          "type": "object",
          "description": "object for creating of record locking configuration.",
          "properties": {
            "lock_type": {
              "type": "string",
              "description": "Lock type",
              "enum": [
                "automatic",
                "manual",
                "both"
              ]
            },
            "locked_for": {
              "type": "string",
              "description": "Lock for",
              "enum": [
                "all_profiles",
                "all_profiles_except_excluded_profiles"
              ]
            },
            "restricted_actions": {
              "type": "array",
              "description": "List of restricted actions.",
              "maxItems": 10,
              "items": {
                "type": "string",
                "description": "A restricted action.",
                "enum": [
                  "change_owner",
                  "update",
                  "delete",
                  "tags"
                ]
              }
            },
            "excluded_fields": {
              "type": "array",
              "description": "Fields excluded from locking.",
              "maxItems": 15,
              "items": {
                "type": "object",
                "description": "Field descriptor to be excluded from locking.",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Field id.",
                    "maxLength": 255
                  }
                },
                "required": [
                  "id"
                ],
                "additionalProperties": false
              }
            },
            "feature_type": {
              "type": "string",
              "description": "Feature type identifier.",
              "enum": [
                "record_locking"
              ]
            },
            "locking_rules": {
              "type": "array",
              "description": "Locking rules for the configuration.",
              "maxItems": 5,
              "items": {
                "type": "object",
                "description": "A locking rule object.",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Name of the locking rule.",
                    "maxLength": 256
                  },
                  "lock_existing_records": {
                    "type": "boolean",
                    "description": "Whether to lock existing records matching criteria."
                  },
                  "criteria": {
                    "type": "object",
                    "description": "Criteria object used to match records.",
                    "additionalProperties": true
                  }
                },
                "required": [
                  "name",
                  "criteria"
                ],
                "additionalProperties": false
              }
            },
            "restricted_communications": {
              "type": "array",
              "description": "List of restricted communications.",
              "maxItems": 10,
              "items": {
                "type": "string",
                "description": "A restricted communication action.",
                "enum": [
                  "send_mail"
                ]
              }
            },
            "restricted_custom_buttons": {
              "type": "array",
              "description": "List of restricted custom buttons.",
              "maxItems": 30,
              "items": {
                "type": "object",
                "description": "Restricted custom button descriptor.",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Identifier of the custom button.",
                    "maxLength": 255
                  }
                },
                "required": [
                  "id"
                ],
                "additionalProperties": false
              }
            },
            "lock_excluded_profiles": {
              "type": "array",
              "description": "Profiles excluded from locking.",
              "maxItems": 15,
              "items": {
                "type": "object",
                "description": "Profile descriptor excluded from locking.",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Profile id.",
                    "maxLength": 255
                  }
                },
                "required": [
                  "id"
                ],
                "additionalProperties": false
              }
            },
            "lock_for_portal_users": {
              "type": "boolean",
              "description": "Whether portal users are affected by the lock."
            }
          },
          "required": [
            "lock_type"
          ],
          "additionalProperties": true
        }
      }
    },
    "required": [
      "module",
      "record_locking_configurations"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Response object for successful creation of record locking configuration. |
| `result.data.record_locking_configurations` | `array` | Yes | — | An array containing details of the created record locking configuration. Maximum items: 1. |
| `result.data.record_locking_configurations[].status` | `"success"` | Yes | — | Indicates that the configuration creation operation was successful. Allowed: `success`. |
| `result.data.record_locking_configurations[].code` | `"SUCCESS"` | Yes | — | A code representing the successful configuration creation operation. Allowed: `SUCCESS`. |
| `result.data.record_locking_configurations[].message` | `string` | Yes | — | A message that provides additional information about the creation operation. Maximum length: 255. |
| `result.data.record_locking_configurations[].details` | `object` | Yes | — | Object containing identifiers and details for the created record locking configuration. |
| `result.data.record_locking_configurations[].details.id` | `string` | Yes | — | The unique identifier of the created record locking configuration. Maximum length: 255. |
| `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": "Response object for successful creation of record locking configuration.",
        "properties": {
          "record_locking_configurations": {
            "type": "array",
            "description": "An array containing details of the created record locking configuration.",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "An object containing the details of the record locking configuration created for the module.",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Indicates that the configuration creation operation was successful.",
                  "enum": [
                    "success"
                  ]
                },
                "code": {
                  "type": "string",
                  "description": "A code representing the successful configuration creation operation.",
                  "enum": [
                    "SUCCESS"
                  ]
                },
                "message": {
                  "type": "string",
                  "description": "A message that provides additional information about the creation operation.",
                  "maxLength": 255
                },
                "details": {
                  "type": "object",
                  "description": "Object containing identifiers and details for the created record locking configuration.",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "The unique identifier of the created record locking configuration.",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "id"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "status",
                "code",
                "message",
                "details"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "record_locking_configurations"
        ],
        "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.