deleteRecords Method
Table of Contentsup
Purpose
You can use this method to delete the selected record (you must specify unique ID of the record) and move to the recycle bin.
Note:
- This method is available for all modules. Using this method, you cannot delete the records permanently from your account.
Request URL
XML Format:
https://<APPDOMAIN>/crm/private/xml/Leads/deleteRecords?id=Record ID
JSON Format:
https://<APPDOMAIN>/crm/private/json/Leads/deleteRecords?id=Record ID
Auth Token
Auth Token is an encrypted alphanumeric string that is required to authenticate your CRM account credentials. A valid user's Authentication Token is necessary to access the API. When making an API request, send the authentication token in the Authorization header as shown below:
https://<APPDOMAIN>/crm/private/xml/Leads/deleteRecords?id=Record ID
Header:
Authorization=1000XXXX65.1000XXXX44.caXXXXXXXXXXXX
(See Using Authentication Token )
Request Parameters
Parameter | Data Type | Description |
id* | String | Specify unique ID of the record |
* - Mandatory Parameter
Example
URL Format:
https://<APPDOMAIN>/crm/private/xml/Leads/deleteRecords?id=Record ID