Delete Activities of a Lead
Lets you delete one or more activities posted on a lead by passing the “ProspectId” (LeadId) and the list of “ActivityEvents”*.
- You can optionally pass a “FromDate” and “ToDate” to delete activities within a certain period.
- You can also pass a “StatusWebhookURL” to post the API response to a URL of your choice.
*Also known as activity codes. You can find them on the Custom Activities & Scores page, under the ‘Code’ column. Alternatively, you can call the Get List of Activity Types API.
Note:
- The supported DateTime format is UTC (YYYY-MM-DD HH:MM:SS).
- The API deletes activities of the type you specify. The activity type itself is not deleted.
- The API only deletes custom activities. You cannot delete system activities.
API URL
URL
POST
https://{host}/v2/ProspectActivity.svc/DeleteActivities?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"ProspectId": "3aee22bd-8419-422a-8242-c510df9af021",
"ActivityEventList": ["163","166"],
"FromDate": "2018-04-30 18:30:00",
"ToDate": "2018-06-20 18:29:59",
"StatusWebhookURL": "https://myurl"
}
Request Parameters
| Parameter | Description |
|---|
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Message": {
"Message": "Your request for delete activities has been queued."
}
}
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. |
