Unlock Records

Purpose

To remove lock from locked records.

Endpoints

Request Details

Request URL

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

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.modules.lockinginformation.Delete(and)
scope=ZohoCRM.modules.All (or) scope=ZohoCRM.modules.{module_name}.{operation_type}

Possible module names

leads, accounts, contacts, deals, tasks, cases, solutions, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices and custom

Possible operation types

All - Full access to the record
Delete - Delete records of the module

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v4/Leads/5843104000000425565/Locking_Information__s/5843104000000804005"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

  • INVALID_MODULEHTTP 400

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

  • NOT_ALLOWEDHTTP 403

    Automatically locked records can not be unlocked manually.

  • NO_PERMISSIONHTTP 403

    The current user does not have permission to unlock record.
    Resolution: Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error.
    Resolution:Unexpected and unhandled exception in the server. Contact support team.

Sample Response

Copied{
  "data": [
    {
      "code": "SUCCESS",
      "details": {
        "id": "5843104000000804005"
      },
      "message": "relation removed",
      "status": "success"
    }
  ]
}