- Overview
- What's New in V5?
- Changelog
- API Directory
- API Collection
- OAuth Authentication
- API Limits
- Multi DC Support
- Increase API Credits
- Customize API Usage Notification
- GDPR Compliance
- HIPAA Compliance
- API Dashboard
- HTTP Request Methods
- Status Codes
- Metadata APIs
- Modules
- Fields
- Layouts
- Related Lists
- Profiles
- Custom View
- Roles
- Territories
- GETTerritories
- POSTTerritories
- PUTTerritories
- DELETETerritories
- POSTTransfer and Delete Territories
- GETChild Territories of a Territory
- POSTAssign Territories to Records
- GETTerritories Assigned
- POSTRemove Territories of Records
- GETAssociated User Count
- PUTAssociate Users with Territory
- DELETEDisassociate Users from Territory
- GETRetrieve User details Associated with a Territory
- Scoring Rules
- Variables
- Map Dependency
- User Groups
- Tags
- Pipeline
- Wizards
- Assignment Rules
- Templates
- User's Unavailability
- Portals
- Fiscal Year
- Business Hours
- Holidays
- Record Locking Configuration
- Shift Hours
- Entity APIs
- Organization
- Users
- Records
- Related Records
- Records APIs using External ID
- Meeting Cancel
- Subforms
- Linking Modules
- Contact Roles
- Photos and Attachments
- Mass Update
- Mass Delete
- Currencies
- Files
- Share
- Fields' Attachments
- Change Owner
- Mass Change Owner
- Blueprint
- Emails
- Notes
- Related Records Using External ID
- Composite API
- Bulk APIs
- Notification APIs
- Query API
Delete Records Using External ID
Purpose
To delete the records in a module using external IDs.
Request Details
Request URL
https://www.zohoapis.com/crm/{version}/{module_api_name}
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
X-EXTERNAL: {module_API_name}.{external_field_API_name}
Scope
scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}
Possible module names
leads, deals, contacts, accounts, products, campaigns, services, appointments and pricebooks
Possible operation types
ALL - Full access to the records
WRITE - Edit records in the module
DELETE - Delete records from the module
Deleting a record using an external ID
In this example, we will delete the record in the Contacts module with the external value extcontact3 in the external field "External_Contact_ID".
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v5/Contacts/extcontact3"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-H "X-EXTERNAL: Contacts.External_Contact_ID"Sample Response
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"External_Contact_ID": "extcontact4",
"id": "111111000000110002"
},
"message": "record deleted",
"status": "success"
}
]
}Deleting the records using the "ids" parameter
In this example, we have used the "ids" parameter with values as the values of the external field in the Contacts module.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v5/Contacts?ids=extcontact3,extcontact4"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-H "X-EXTERNAL: Contacts.External_Contact_ID"Possible Errors
- INVALID_DATAHTTP 400
The value of the external field is invalid.
Resolution: Specify the correct external ID of the record.
Sample Response
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"External_Contact_ID": "extcontact3",
"id": "111111000000101047"
},
"message": "record deleted",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"External_Contact_ID": "extcontact4",
"id": "111111000000101018"
},
"message": "record deleted",
"status": "success"
}
]
}Show full
Show less
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.