Record Lockings APIs in Zoho CRM

Hello everyone!

Welcome to Kaizen! In the previous Kaizen post, we discussed Record Locking Configuration APIs. In this post, we will discuss Record Locking APIs in Zoho CRM.

Record locking refers to the restrictions applied to a record to prevent changes to its data. Records can be locked manually or automatically. Record Locking Configuration APIs are used to set the configuration required for record locking.

Locking Information Module

When record locking configuration is enabled for any module, a new module will be created in the CRM with the API Name Locking_Information__s that contains the details related to locking information. Details related to this module can be retrieved using the Modules API (endpoint: /settings/modules) and corresponding fields can be fetched via Fields META API (endpoint: /settings/fields?module=Locking_Information__s). The fields of Locking_Information__s module are:

Name	Data Type	Description
Locked_Reason__s	textarea	Reason for locking the record.
Lock_Source__s	picklist	Indicates whether the record was manually locked or automatically locked. Possible values: Automatic, Manual
Locked_For__s	multi module lookup	This field contains the details of the name and id of the record which is locked and also the api_name and id of the the record's module.
Locked_Time__s	datetime	Time the record was locked.
Locked_By__s	user lookup	Details of the user who locked the record(manual locking).
id	bigint	ID of record locking information.This id is referred as record_locking_id in the below APIs
Record_Locking_Rule_Id__s	bigint	ID of the record locking rule inside the module's record locking configuration
Record_Locking_Configuration_Id__s	bigint	ID of the record locking configuration.
Feature_Type__s	picklist	Represents feature type (possible value:record_locking)

When a record gets locked in any module, corresponding details are stored in the Locking_Information__s module as a new record.

The ID key inside the Locked_For__s json object in Locking_Information__s module points to the locked record.

"Locked_For__s": {

"module": {

"api_name": "Deals",

"id": "5843104000000002181"//id of Deals module

"name": "Commercial Press",

"id": "5843104000001068086"//id of locked record i.e.{record_id}

}

Deleting the record inside Locking_Information__s module unlocks the locked record.

However, these actions have to be performed using Locking_Information__s Related Record APIs of the record.

URL Pattern for the same is

{api-domain}/crm/{version}/{module_api_name}/{record_id}/Locking_Information__s [POST]

{api-domain}/crm/{version}/{module_api_name}/{record_id}/Locking_Information__s/{record_locking_id}[GET/PUT/DELETE]

Get Record Locking Information API

With this API, you can retrieve the locking information of locked records.

Request URL:

{api-domain}/crm/{version}/{module_API_name}/{record_id}/Locking_Information__s/{record_locking_id}

{api-domain}/crm/{version}/{module_API_name}/{record_id}/Locking_Infortmation__s?fields={field_name_1},{field_name_2}

HTTP Method: GET

Please note that the fields parameter is mandatory when you are not passing the record locking id in the endpoint.

Consider that the record locking configuration for deals module is configured to automatically lock a record when it reaches the closed lost stage. A deals record in closed lost stage gets automatically locked. You can obtain the details of the locking information using this API.

Sample Request URL to fetch the locking information of a record in Deals module:

[GET] {api-domain}/crm/v5/Deals/5843104000001068077/Locking_Information__S?fields=Locked_For__s,Locked_Reason__s,Lock_Source__s,Locked_Time__s,Locked_By__s,Record_Locking_Rule_Id__s,Record_Locking_Configuration_Id__s,Owner,Parent_Id

Response Body:

{

"data": [

{

"Locked_By__s": null,

"Locked_For__s": {

"module": {

"api_name": "Deals",

"id": "5843104000000002181"

"name": "Commercial Press",

"id": "5843104000001068077"

"$field_states": null,

"Locked_Reason__s": null,

"$editable": false,

"$sharing_permission": "read_only",

"Lock_Source__s": "Automatic",

"Locked_Time__s": "2023-10-23T17:46:17+05:30",

"Record_Locking_Configuration_Id__s": "5843104000001068044",

"Record_Locking_Rule_Id__s": "5843104000001068069",

"id": "5843104000001072001",

"Feature_Type__s": "record_locking",

"$zia_visions": null

}

]

}

Lock Records API

In certain scenarios, even if the record does not meet the configured locking criteria, you call the below API to manually lock it to prevent any changes to the record.

Request URL:

{api-domain}/crm/{version}/{module_API_name}/{record_id}/Locking_Information__s

HTTP Method: POST

For instance, you are handling a deal and want to temporarily prevent any modifications to the deal information because the deal is in the last round of negotiations. You can choose to manually lock the record using the Lock Records API.

Sample Request URL for manually locking deals record:

[POST] {api-domain}/crm/v5/Deals/5843104000001068086/Locking_Information__s

Request Body:

{

"data": [

{

"Locked_Reason__s": "last round of negotiations "

}

]

}

Update Record Locking Information API

The locked reason for a manually locked record can be updated using Update Record Locking Information API.

Request URL:

{api-domain}/crm/{version}//{module_API_name}/{record_id}/Locking_Information__s/{record_locking_id}

HTTP Method: PUT

Consider that you want to modify the locked reason for the above locked record.

Sample Request URL to modify locked reason for the above locked deal:

[PUT] {api-domain}/crm/v5/Deals/5843104000001068086/Locking_Information__s/5843104000001068094
Request Body:

{

"data": [

{

"Locked_Reason__s": "awaiting final approval"

}

]

}

Unlock Records API

This API can be used to unlock a manually locked record.

Request URL:

{api-domain}/crm/{version}/{module_API_name}/{record_id}/Locking_Information__s/{record_locking_id}

HTTP Method: DELETE

Consider that you want to unlock the above deal to move it to closed won stage. You can unlock the deal using this API.

Sample Request URL to unlock the above deal:

[DELETE] {api-domain}/crm/v5/Deals/5843104000001068086/Locking_Information__s/5843104000001068094

Response Body:

{

"data": [

{

"code": "SUCCESS",

"details": {

"id": "5843104000001068094"

"message": "relation removed",

"status": "success"

}

]

}

We hope you found this article useful. We will be back next week with another interesting topic. If you have any questions, write to us at support@zohocrm.com or let us know in the comment section.

Please take a look at our Kaizen collection here.

Cheers!

Previous Kaizen - Record Locking Configuration APIs in Zoho CRM

Access your files securely from anywhere

Zoho Developer Community

New to Zoho LandingPage?

Access Zoho LandingPage

Zoho LandingPage Resources

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Tout forum

France ZUGs

Zoho SalesIQ Resources

Sticky Posts
Kaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provide
Client Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands
Extension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use API
Kaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved
Extension pointers for integrating Zoho CRM with Zoho products #8: Upload and manage Zoho Workdrive folders and files from within Zoho CRM
Keeping records on your customers and business prospects is essential for tracking data, conducting follow-ups, and running a business smoothly. When you use two separate applications, and store relevant data in each, checking and tracking data becomes