Delete a Lead’s Owner Change History

This API lets you delete the owner change history of a lead.

  • It’s mandatory to pass the ‘ProspectId’ to specify a lead.
  • You can optionally pass a ‘FromDate’ and ‘ToDate’ to delete owner change activities within a certain period.

When a lead’s owner changes, an activity is posted on the lead details page. This API removes all such activities.

stage change activities delete

API URL

POST
https://{host}/v2/LeadManagement.svc/DeleteUserAssignmentChangeHistory?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{
  "ProspectId": "<>",
  "FromDate": "yyyy-MM-dd HH:mm:ss",
  "ToDate": "yyyy-MM-dd HH:mm:ss",
  "StatusWebhookURL": ""
}

JSON Properties

Parameter Description
ProspectId

The unique identifier of the lead.

For example, 3aee22bd-8419-422a-8242-c510df9af021

FromDate

Start date of the period you want to delete the owner change history from.

ToDate

End date of the period you want change the owner change history till.

StatusWebhookURL

Enter a webhook URL to post the response data to.

Response

200 OK

Content-Type: application/json

{
  "Status": "Success",
  "Message": {
    "Message": "Your request for delete user assignment 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.