Record Locking Information APIs allows you to lock records, unlock records, view locking information of locked records and edit locking information of locked records.
{
"openapi": "3.1.0",
"info": {
"title": "Locking Information",
"description": "Record Locking Information APIs allows you to lock records, unlock records, view locking information of locked records and edit locking information of locked records.",
"version": "8"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"enum": [
"com",
"eu",
"in",
"cn",
"au"
],
"default": "com",
"description": "API Server URL TLD"
},
"version": {
"default": "v8",
"description": "API version"
}
}
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.modules.ALL"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.lockinginformation.ALL"
]
}
],
"paths": {
"/{moduleName}/{recordId}/Locking_Information__s": {
"get": {
"operationId": "getRecordLockingInformationOfTheRecord",
"summary": "To retrieve the locking information details of locked records",
"description": "Use the Get Record Locking Information API to retrieve the locking information details of locked records in different modules.",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.modules.READ"
]
}
],
"parameters": [
{
"$ref": "#/components/parameters/ModuleName"
},
{
"$ref": "#/components/parameters/RecordId"
},
{
"$ref": "#/components/parameters/Fields"
}
],
"responses": {
"200": {
"description": "To retrieve the locking information details of locked records.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"description": "A JSON object containing the locking information details of locked records.",
"properties": {
"data": {
"type": "array",
"maxItems": 1,
"description": "An array of objects containing the locking information details of locked records.",
"items": {
"type": "object",
"additionalProperties": false,
"description": "An object containing the locking information details of a locked record.",
"properties": {
"Locked_By__s": {
"additionalProperties": false,
"description": "An object containing the details of the user who locked the record.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the user who locked the record.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "The ID of the user who locked the record.",
"maxLength": 255
},
"module": {
"type": "string",
"description": "The module of the user who locked the record.",
"maxLength": 255
}
},
"required": [
"name",
"id",
"module"
]
},
"Locked_For__s": {
"type": "object",
"additionalProperties": false,
"description": "An object containing the details of the record that is locked.",
"properties": {
"module": {
"type": "object",
"additionalProperties": false,
"description": "An object containing the details of the module of the locked record.",
"properties": {
"api_name": {
"type": "string",
"description": "The API name of the module of the locked record.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "The ID of the module of the locked record.",
"maxLength": 255
}
},
"required": [
"api_name",
"id"
]
},
"name": {
"type": "string",
"description": "The name of the locked record.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "The ID of the locked record.",
"maxLength": 255
}
},
"required": [
"module",
"name",
"id"
]
},
"$field_states": {
"description": "The field states of the locked record. Can be null when no field state is present.",
"anyOf": [
{
"type": "string",
"maxLength": 255,
"description": "The field states of the locked record."
},
{
"type": "null",
"description": "No field state is present."
}
]
},
"Locked_Reason__s": {
"type": "string",
"description": "The reason for locking the record.",
"maxLength": 3000
},
"$editable": {
"type": "boolean",
"description": "Indicates whether the locked record is editable."
},
"$sharing_permission": {
"type": "string",
"description": "The sharing permission of the locked record.",
"maxLength": 10000
},
"Lock_Source__s": {
"type": "string",
"description": "The source of the lock.",
"maxLength": 255,
"enum": [
"Manual",
"Both",
"Automatic"
]
},
"Locked_Time__s": {
"type": "string",
"description": "The time when the record was locked.",
"format": "date-time"
},
"Record_Locking_Configuration_Id__s": {
"type": "string",
"description": "The ID of the record locking configuration.",
"maxLength": 255
},
"Record_Locking_Rule_Id__s": {
"type": [
"string",
"null"
],
"description": "The ID of the record locking rule.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "The ID of the locking information record.",
"maxLength": 255
},
"Feature_Type__s": {
"type": "string",
"description": "The feature type of the locking information.",
"maxLength": 255
},
"$zia_visions": {
"description": "Zia Visions related information. Can be null when not present.",
"anyOf": [
{
"type": "string",
"maxLength": 255,
"description": "Zia Visions related information."
},
{
"type": "null",
"description": "No Zia Visions information is present."
}
]
}
},
"required": [
"id"
]
}
},
"info": {
"type": "object",
"additionalProperties": false,
"description": "An object containing the pagination details.",
"properties": {
"per_page": {
"type": "integer",
"format": "int32",
"description": "The number of records per page."
},
"count": {
"type": "integer",
"format": "int32",
"description": "The total number of records."
},
"page": {
"type": "integer",
"format": "int32",
"description": "The current page number."
},
"more_records": {
"type": "boolean",
"description": "Indicates if there are more records available."
}
},
"required": [
"per_page",
"count",
"page",
"more_records"
]
}
},
"required": [
"data",
"info"
]
}
}
}
},
"204": {
"description": "When the record is not locked by the record locking configuration, this response will be returned."
},
"400": {
"description": "Bad Request — Invalid or missing parameters.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "This error occurs when the specified relation is not found.",
"properties": {
"code": {
"type": "string",
"enum": [
"INVALID_DATA"
],
"description": "Error code indicating invalid data."
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Additional details about the error."
},
"message": {
"type": "string",
"enum": [
"relation not found"
],
"description": "Error message indicating the relation was not found."
},
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Status of the error response."
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "This error occurs when the module name provided is invalid.",
"properties": {
"code": {
"type": "string",
"enum": [
"INVALID_MODULE"
],
"description": "Error code indicating an invalid module."
},
"details": {
"type": "object",
"description": "Additional details about the error.",
"additionalProperties": false,
"properties": {
"resource_path_index": {
"type": "integer",
"format": "int32",
"description": "Index of the resource path where the error occurred."
}
},
"required": [
"resource_path_index"
]
},
"message": {
"type": "string",
"enum": [
"the module name given seems to be invalid"
],
"description": "Error message indicating the module name is invalid."
},
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Status of the error response."
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "This error occurs when the relation ID provided is invalid.",
"properties": {
"code": {
"type": "string",
"enum": [
"INVALID_DATA"
],
"description": "Error code indicating invalid data."
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Additional details about the error.",
"properties": {
"resource_path_index": {
"type": "integer",
"format": "int32",
"description": "Index of the resource path where the error occurred."
}
},
"required": [
"resource_path_index"
]
},
"message": {
"type": "string",
"enum": [
"the related id given seems to be invalid"
],
"description": "Error message indicating the relation ID is invalid."
},
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Status of the error response."
}
},
"required": [
"code",
"details",
"message",
"status"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "This error occurs when the required record locking configuration is not present.",
"properties": {
"code": {
"type": "string",
"enum": [
"NOT_ALLOWED"
],
"description": "Error code indicating the action is not allowed."
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Additional details about the error.",
"properties": {
"resource_path_index": {
"type": "integer",
"format": "int32",
"description": "Index of the resource path where the error occurred."
}
},
"required": [
"resource_path_index"
]
},
"message": {
"type": "string",
"enum": [
"Required Record Locking Configuration is not present"
],
"description": "Error message indicating the locking configuration is missing."
},
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Status of the error response."
}
},
"required": [
"code",
"details",
"message",
"status"
]
}
]
}
}
}
}
}
},
"post": {
"operationId": "lockRecord",
"summary": "To lock a record of a module",
"description": "Use the Lock Record API to lock records in different modules.",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.modules.CREATE"
]
}
],
"parameters": [
{
"$ref": "#/components/parameters/RecordId"
},
{
"$ref": "#/components/parameters/ModuleName"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"description": "A JSON object containing the reason for locking the record.",
"properties": {
"data": {
"type": "array",
"maxItems": 1,
"description": "An array containing the reason for locking the record.",
"items": {
"additionalProperties": false,
"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"
]
}
}
},
"required": [
"data"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "To lock a record of a module.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"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",
"additionalProperties": false,
"description": "An object containing the success response for locking the record.",
"properties": {
"status": {
"type": "string",
"enum": [
"success"
],
"description": "Indicates the success status of the lock operation."
},
"code": {
"type": "string",
"enum": [
"SUCCESS"
],
"description": "A code representing the successful lock operation."
},
"message": {
"type": "string",
"description": "A message providing additional information about the lock operation.",
"maxLength": 255
},
"details": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "An object containing the details of the locked record.",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the locked record.",
"maxLength": 255
},
"Created_Time": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the record was created."
},
"Modified_Time": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the record was last modified."
},
"Modified_By": {
"type": "object",
"additionalProperties": false,
"description": "An object containing information about the user who last modified the record.",
"properties": {
"name": {
"type": "string",
"description": "The name of the user who last modified the record.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "The unique identifier of the user who last modified the record.",
"maxLength": 255
}
},
"required": [
"name",
"id"
]
},
"Created_By": {
"type": "object",
"additionalProperties": false,
"description": "An object containing information about the user who created the record.",
"properties": {
"name": {
"type": "string",
"description": "The name of the user who created the record.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "The unique identifier of the user who created the record.",
"maxLength": 255
}
},
"required": [
"name",
"id"
]
}
},
"required": [
"id",
"Created_Time",
"Modified_Time",
"Modified_By",
"Created_By"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "An object containing minimal details of the locked record.",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the locked record.",
"maxLength": 255
}
},
"required": [
"id"
]
}
]
}
},
"required": [
"status",
"code",
"message",
"details"
]
}
}
},
"required": [
"data"
]
}
}
}
},
"400": {
"description": "Bad Request — The server could not process the request.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "This error occurs when a required field is missing in the request payload.",
"properties": {
"data": {
"type": "array",
"maxItems": 1,
"description": "List of errors related to missing mandatory fields.",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Details of a missing mandatory field error.",
"properties": {
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Status of the error response."
},
"code": {
"type": "string",
"enum": [
"MANDATORY_NOT_FOUND"
],
"description": "Error code indicating a mandatory field is missing."
},
"message": {
"type": "string",
"enum": [
"required field not found"
],
"description": "Error message indicating the required field was not found."
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Details about the missing mandatory field.",
"properties": {
"api_name": {
"type": "string",
"description": "API name of the missing field",
"maxLength": 256
},
"json_path": {
"type": "string",
"description": "JSON path to the missing field",
"maxLength": 256
}
},
"required": [
"api_name",
"json_path"
]
}
},
"requir
# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-locking-informations-openapi.json