Deletes the stage change history of a lead.
- Specify the “ProspectId” (Lead Id) in the API request.
- You can optionally pass a “FromDate” and “ToDate” to delete stage changes within a certain period.
- You can also pass a “StatusWebhookURL” to post the API response to a URL of your choice.
API URL
POST
https://{host}/v2/LeadManagement.svc/DeleteStageChangeHistory?accessKey=AccessKey&secretKey=SecretKey
Copy URL
Request
JSON Body/Payload
Content-Type: application/json
{
"ProspectId": "3aee22bd-8419-422a-8242-c510df9af021",
"FromDate": "2018-04-30 18:30:00",
"ToDate": "2018-05-31 18:29:59",
"StatusWebhookURL": "http://myurl"
}
JSON Properties
{ "ProspectId": "3aee22bd-8419-422a-8242-c510df9af021", "FromDate": "2018-04-30 18:30:00", "ToDate": "2018-05-31 18:29:59", "StatusWebhookURL": "http://myurl" }
JSON Properties
Parameter | Description |
---|
Response
200 OK
Content-Type: application/json
{ "Status": "Success", "Message": { "Message": "Your request for delete stage change history has been queued." } }
HTTP Response Code
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. |