Delete Tasks in Bulk
Lets you bulk delete tasks by passing their Tasks Ids. You can also pass a webhook URL to post the delete status to. Task deletion is performed asynchronously. The webhook will be invoked when the bulk task delete operation is completed.
Note: Maximum of 5,000 tasks can be sent in one request.
API URL
URL
POST
https://{host}/v2/Task.svc/DeleteTasks?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"TaskIds": [
"0017abfa-c100-11e5-9340-06c7eb5c8385",
"003bf10c-317e-11e8-bf3d-069b743e848f",
"00853195-07f0-11e7-a909-02dc6309a6b5",
"008c1729-0945-11e7-a909-02dc6309a6b5"
],
"StatusWebhookURL": "https://webhook.site/9f209c1f-44eb-4050-a704-e8bd3d54e82c"
}
Request Parameters
| Parameter | Description |
|---|---|
| TaskIds | Id of the tasks you wish to delete. You can retrieve task Ids by calling the Get Tasks API. Note: Maximum of 5,000 tasks can be sent in one request. |
| StatusWebhookURL | Pass a webhook URL to post the delete status. |
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Operation": "Bulk Delete Tasks",
"TasksCount": 67,
"DeletedTasksCount": 67,
"FailureReason": null
}
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. |
