Delete Record Locking Configuration

Purpose

To delete the record locking configuration for different modules.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/settings/record_locking_configurations/{record_locking_config_id}?module={module_API_name}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.record_locking_configurations.Delete

Parameters
  • modulestring, mandatory

    You should specify the API name of the required module to delete record-locking configuration with respect to that module.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v6/settings/record_locking_configurations/5843104000000758004?module=Leads"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X DELETE

Possible Errors

  • REQUIRED_PARAM_MISSINGHTTP 400

    One of the expected parameters is missing.
    Resolution: The "details" key in the response gives the missing param in the request. Ensure that you include the params marked "mandatory" in the "Parameters" section.

  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid.
    Resolution: Specify a valid module API name.

  • NOT_SUPPORTEDHTTP 400

    The given module is not supported.

    Resolution: Specify supported modules.

  • FEATURE_NOT_SUPPORTEDHTTP 400

    When record locking configuration is not supported in the user's current edition.

  • NO_PERMISSIONHTTP 403

    Permission denied to customize record lock configurations. The user does not have permission.
    Resolution: Contact your system administrator.

  • NOT_ALLOWEDHTTP 403

    Configuration created by system cannot be deleted.
    Resolution: Contact your system administrator.

Sample Response

Copied{
  "record_locking_configurations": [
    {
      "code": "SUCCESS",
      "details": {
        "id": "5843104000000758004"
      },
      "message": "record locking configuration deleted",
      "status": "success"
    }
  ]
}