Delete a Lead
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Lets you to delete a lead by passing the “LeadId” in the JSON payload.
Note:
- Once a lead is deleted, the operation cannot be reversed.
- When a lead is deleted, all associated information (opportunities, activities, tasks, history of audits, attached files etc.) is hard deleted from the system.
- We do not support bulk lead deletion (there are no bulk delete lead APIs).
- This API doesn’t work automatically. Please write to LeadSquared support at support@leadsquared.com if you want to enable this API.
API URL
URL
GET
https://{host}/v2/LeadManagement.svc/Lead/Delete/ById?accessKey=AccessKey&secretKey=SecretKey&leadId=LeadId
URL Parameters
| Parameter | Description |
|---|---|
| LeadId | Unique identifier of the of the lead. |
Response
200 OK
Content-Type: application/json
{"Status": "Success"}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
