openapi: 3.1.0 info: title: Helpcenter Locking Information S API version: 1.0.0 tags: - name: Locking Information S 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 tags: - Locking Information S 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 required: - status - code - message - details required: - data - type: object additionalProperties: false description: This error occurs when the specified relation is not found. properties: status: type: string enum: - error description: Status of the error response. code: type: string enum: - INVALID_REQUEST_METHOD description: Error code indicating invalid request method. message: type: string description: Error message indicating the request method is invalid. maxLength: 256 details: type: object additionalProperties: false description: Details about the invalid request method. required: - status - code - message - details - type: object additionalProperties: false description: This error occurs when the specified relation is not found. properties: status: type: string enum: - error description: Status of the error response. code: type: string enum: - INVALID_DATA description: Error code indicating invalid data. message: type: string description: Error message indicating invalid data. maxLength: 256 details: oneOf: - type: object additionalProperties: false description: Additional details about the invalid data error. - type: object additionalProperties: false description: Details about the invalid data error including the resource path index. properties: resource_path_index: type: integer format: int32 description: Index of the resource path where the error occurred. required: - resource_path_index required: - status - code - message - details - type: object additionalProperties: false description: This error occurs when the module name provided is invalid. properties: status: type: string enum: - error description: Status of the error response. code: type: string enum: - INVALID_MODULE description: Additional details about the error. message: type: string description: Error message indicating the module name is invalid. maxLength: 256 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 required: - status - code - message - details - type: object additionalProperties: false description: This error occurs when the required record locking configuration is not present. properties: status: type: string enum: - error description: Status of the error response. code: type: string enum: - NOT_ALLOWED description: Error code indicating the action is not allowed. message: type: string description: Error message indicating the locking configuration is missing. maxLength: 256 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 required: - status - code - message - details '403': description: The request was understood by the server, but it was refused due to insufficient permissions or security restrictions. content: application/json: schema: type: object additionalProperties: false description: A JSON object containing the error response when the lock operation is not allowed. properties: status: type: string enum: - error description: Indicates the error status of the lock operation. code: type: string enum: - NOT_ALLOWED - NO_PERMISSION description: A code representing the reason why the lock operation is not allowed. message: type: string description: A message providing additional information about why the lock operation is not allowed. maxLength: 255 details: type: object additionalProperties: false description: Additional details about the error. properties: resource_path_index: type: integer description: Index of the resource path where the error occurred. format: int32 required: - resource_path_index required: - status - code - message - details tags: - Locking Information S /{moduleName}/{recordId}/Locking_Information__s/{lockId}: put: operationId: updateReasonofLockedRecord summary: To update the locking reason of a locked record description: Use the Update Record Locking Infromation API to modify locking information of locked records in different modules. security: - iam-oauth2-schema: - ZohoCRM.settings.modules.ALL parameters: - name: moduleName description: The API name of the module to which the record belongs. in: path required: true schema: type: string maxLength: 255 - name: recordId description: The unique identifier of the record whose locking reason needs to be updated. in: path required: true schema: type: string maxLength: 32 - $ref: '#/components/parameters/LockId' requestBody: content: application/json: schema: type: object additionalProperties: false description: A JSON object containing the updated reason for locking the record. properties: data: type: array description: An array containing the updated reason for locking the record. maxItems: 1 items: type: object additionalProperties: false description: An object containing the updated reason for locking the record. properties: Locked_Reason__s: type: string description: The updated reason for locking the record. maxLength: 3000 required: - Locked_Reason__s required: - data required: true responses: '200': description: Use the Update Record Locking Infromation API to modify locking information of locked records in different modules. content: application/json: schema: type: object additionalProperties: false description: A JSON object containing the success response for updating the locking reason of a locked record. properties: data: type: array description: An array containing the success response for updating the locking reason of a locked record. maxItems: 1 items: type: object additionalProperties: false description: An object containing the success response for updating the locking reason of a locked record. properties: status: type: string enum: - success description: Indicates the success status of the update operation. code: type: string enum: - SUCCESS description: A code representing the successful update operation. message: type: string description: A message providing additional information about the update operation. maxLength: 255 details: anyOf: - type: object additionalProperties: false description: An object containing the details of the updated locked record. properties: id: type: string description: The unique identifier of the updated 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 - type: object additionalProperties: false description: An object containing minimal details of the updated locked record. properties: id: type: string description: The unique identifier of the updated locked record. maxLength: 255 required: - id required: - status - code - message - details required: - data '400': description: Bad Request — The server could not process the request due to invalid syntax or missing/invalid parameters. content: application/json: schema: oneOf: - type: object additionalProperties: false description: Invalid request method error properties: code: type: string enum: - INVALID_REQUEST_METHOD description: This error occurs when an invalid HTTP method is used to access the API endpoint. details: type: object additionalProperties: false description: An empty object as there are no additional details for this error. message: type: string description: Message of the error indicating the invalid HTTP request method. maxLength: 256 status: type: string enum: - error description: Indicates that the request resulted in an error. required: - code - details - message - status - type: object additionalProperties: false description: This error occurs when a required field is missing in the request payload. properties: data: type: array description: List of errors related to missing mandatory fields. maxItems: 1 items: type: object additionalProperties: false description: Details of a missing mandatory field error. properties: code: type: string enum: - MANDATORY_NOT_FOUND description: Error code indicating a mandatory field is missing. 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 message: type: string enum: - required field not found description: Error message indicating the required field was not found. status: type: string enum: - error description: Status of the error response. required: - code - details - message - status required: - data - 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: Details about the invalid data. message: type: string description: Error message indicating invalid data. maxLength: 256 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 description: Error message indicating the locking configuration is missing. maxLength: 256 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 invalid module name. 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 description: Error message indicating the module name is invalid. maxLength: 256 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 specified record ID 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 description: Error message indicating the module name is invalid. maxLength: 256 status: type: string enum: - error description: Status of the error response. required: - code - details - message - status '403': description: The request was understood by the server, but it was refused due to insufficient permissions or security restrictions. content: application/json: schema: type: object additionalProperties: false description: Error response indicating insufficient permissions or security restrictions. properties: status: type: string enum: - error description: Indicates that the request resulted in an error. code: type: string enum: - NO_PERMISSION - NOT_ALLOWED description: Error code indicating the reason for the refusal. message: type: string description: Error message providing additional information about the refusal. maxLength: 256 details: type: object additionalProperties: false description: Additional details about the error. properties: resource_path_index: type: integer description: Index of the resource path where the error occurred. format: int32 required: - resource_path_index required: - status - code - message - details tags: - Locking Information S delete: operationId: removeLockFromLockedRecord summary: Remove Lock from Locked Records description: Use the Remove Lock from Locked Records API to remove locks from locked records in different modules. security: - iam-oauth2-schema: - ZohoCRM.settings.modules.DELETE parameters: - name: moduleName description: The API name of the module to which the locked record belongs. in: path required: true schema: type: string maxLength: 256 - name: recordId description: The ID of the locked record from which the lock is to be removed. in: path required: true schema: type: string maxLength: 32 - $ref: '#/components/parameters/LockId' responses: '200': description: To remove lock from locked records. content: application/json: schema: type: object additionalProperties: false description: Successful response properties: data: type: array maxItems: 1 description: responses for removing lock from locked records. items: type: object additionalProperties: false description: Details of the remove lock operation. properties: status: type: string enum: - success description: Indicates that the request was successful. code: type: string enum: - SUCCESS description: Indicates that the lock removal was successful. message: type: string description: Message indicating the result of the lock removal operation. maxLength: 256 details: anyOf: - type: object additionalProperties: false description: Details of the removed lock. properties: id: type: string description: The ID of the removed lock. maxLength: 32 Created_Time: type: string format: date-time description: The time when the lock was created. Modified_Time: type: string format: date-time description: The time when the lock was last modified. Modified_By: type: object additionalProperties: false description: Details of the user who last modified the lock. properties: name: type: string description: Name of the user who modified the lock. maxLength: 256 id: type: string description: ID of the user who modified the lock. maxLength: 32 required: - name - id Created_By: type: object additionalProperties: false description: Details of the user who created the lock. properties: name: type: string description: Name of the user who created the lock. maxLength: 256 id: type: string description: ID of the user who created the lock. maxLength: 32 required: - name - id required: - id - type: object additionalProperties: false description: Details of the removed lock. properties: id: type: string description: The ID of the removed lock. maxLength: 32 required: - id required: - status - code - message - details required: - data '400': description: Bad Request — The server could not process the request due to invalid syntax or missing/invalid parameters. content: application/json: schema: oneOf: - type: object additionalProperties: false description: Invalid request method error properties: code: type: string enum: - INVALID_REQUEST_METHOD description: This error occurs when an invalid HTTP method is used to access the API endpoint. details: type: object additionalProperties: false description: An empty object as there are no additional details for this error. message: type: string description: Message of the error indicating the invalid HTTP request method. maxLength: 256 status: type: string enum: - error description: Indicates that the request resulted in an error. required: - code - details - message - status - type: object additionalProperties: false description: This error occurs when a required field is missing in the request payload. properties: data: type: array description: List of errors related to missing mandatory fields. maxItems: 1 items: type: object additionalProperties: false description: Details of a missing mandatory field error. properties: code: type: string enum: - MANDATORY_NOT_FOUND description: Error code indicating a mandatory field is missing. 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 message: type: string enum: - required field not found description: Error message indicating the required field was not found. status: type: string enum: - error description: Status of the error response. required: - code - details - message - status required: - data - 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: Details about the invalid data. 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: - relation not found description: Error message indicating invalid data. 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 - 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 invalid module name. 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 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 specified record ID 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 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 specified record ID 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 id 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 '403': description: The request was understood by the server, but it was refused due to insufficient permissions or security restrictions. content: application/json: schema: type: object description: Error response indicating insufficient permissions or security restrictions. additionalProperties: false properties: status: type: string description: Indicates that the request resulted in an error. enum: - error code: type: string description: Error code indicating the reason for the refusal. enum: - NO_PERMISSION - NOT_ALLOWED message: type: string description: Error message providing additional information about the refusal. maxLength: 256 details: type: object additionalProperties: false description: Additional details about the error. properties: resource_path_index: type: integer description: Index of the resource path where the error occurred. format: int32 required: - resource_path_index required: - status - code - message - details tags: - Locking Information S components: parameters: ModuleName: name: moduleName description: The API name of the module to which the locked record belongs. in: path required: true schema: type: string maxLength: 256 LockId: name: lockId description: The ID of the lock to be removed from the locked record. in: path required: true schema: type: string maxLength: 32 RecordId: name: recordId description: The ID of the record from which the lock is to be removed. in: path required: true schema: type: string maxLength: 32 Fields: name: fields in: query required: false description: A comma-separated list of field API names to be included in the response. schema: type: string maxLength: 2048 securitySchemes: iam-oauth2-schema: $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema x-entity: Helpcenter