Delete Lead
Each API request in TeleCMI platform includes App id and secret. Get your App id and secret in TeleCMI dashboard. After getting the app id and secret, make a POST request to the below endpoint to safely delete a specific lead from the system.
Base URL
https://rest.telecmi.com/v3/leads/delete
Parameters
| Parameter Name | Type | Description |
|---|---|---|
| *inet_no | string/number | The Internet number or identifier associated with the application. |
| *secret | string | Your app secret. |
| *leads_id | string/number | The unique identifier of the lead to be deleted. |
Note
The * marked parameter is mandatory.
Sample JSON Request
{
"inet_no": 1111112,
"secret": "xxxx-xxxx-xxxx-xxxx",
"leads_id": "550e8400-e29b-41d4-a716-446655440000"
}
Sample Response
Success Response
{
"code": 200,
"msg": "Lead Deleted Successfully"
}
Error Responses
Lead Used in Active Campaign
{
"code": 400,
"msg": "Lead is Used in Active Campaign"
}
Lead Not Found
{
"code": 404,
"msg": "Lead not found"
}
Properties
| Property | Type | Description |
|---|---|---|
| code | number | The response or logical status code. |
| msg | string | Message details of the response. |
HTTP status codes
TeleCMI API platform represents the following status codes to identify the outcome.
| Status code | Status Type | Description |
|---|---|---|
| 200 | Success | Lead Deleted Successfully |
| 200 | Error | Lead is Used in Active Campaign (Logical error code 400 in JSON) |
| 200 | Error | Lead not found (Logical error code 404 in JSON) |
| 200 | Error | Something Went Wrong (Logical error code 500 in JSON) |
| 404 | Error | App Not Found |
| 400 / 422 | Error | Validation Failed (Invalid request parameters) |