Delete a Specific Record
Purpose
To delete a particular entity or record.
Request URL
https://www.zohoapis.com/crm/v2/{module_api_name}/{record_id}
module_api_name - The API name of the module
record_id - The unique ID of the record
Modules supported in Get a Specific Record are supported here.
Request Method
DELETE
Scope
scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}
Possible module names | Possible operation types |
---|---|
leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, custom, notes, and activities | ALL - Full access to the record WRITE - Edit records in the module DELETE - Delete records in the module |
Parameters
Parameter Name | Data Type | Description | Possible Values |
---|---|---|---|
wf_trigger (optional) | Boolean | Represents if the workflow rules are to be triggered upon record deletion. The value true triggers workflows. The value false does not trigger workflows. The default value is true. | true or false. |
Note:
By default, all the workflows related to this API will get executed.
All the subforms related to this API will get deleted.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2/Leads/410888000000698006?wf_trigger=true"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedZCRMRecord record = ZCRMRecord.getInstance("Products",12347986875l);//module api name with record id
APIResponse response = record.delete();
String recStatus = response.getStatus();
Copied$zcrmRecordIns = ZCRMRecord::getInstance("Products", 410405000001042005); //record id
$apiResponse=$zcrmRecordIns->delete();
Copied def delete_record(self):
try:
record = ZCRMRecord.get_instance('Leads', 3719520000000316001) #3719520000000316001 is leadid
resp = record.delete()
print(resp.status_code)
print(resp.code)
print(resp.details)
print(resp.message)
print(resp.status)
except ZCRMException as ex:
print(ex.status_code)
print(ex.error_message)
print(ex.error_code)
print(ex.error_details)
print(ex.error_content)
CopiedZCRMRecord record = ZCRMRecord.GetInstance("Products", 3372164000001633018);//module api name with record id
APIResponse response = record.Delete();
Sample Response
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Sample Response
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Sample Response
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Sample Response
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "410888000000698006"
},
"message": "record deleted",
"status": "success"
}
]
}