Cancel Appointments in Bulk
Cancels multiple appointments in one go.
- Pass the “TaskIds” of the appointments you want to cancel.
- You can specify a URL to post the data using the “StatusWebhookURL” parameter.
API URL
URL
POST
https://{host}/v2/Task.svc/BulkCancelAppointment?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"TaskIds": [
"1545aa40-c7e7-11e8-aa1a-02742c1c8abe",
"4aaa63a0-cd37-11e8-ae91-06ee26114d5a"
],
"StatusWebhookURL": "http://track.crm4b2c.com/l/PostDataToFile.aspx"
}
Request Parameters
| Parameter | Description |
|---|---|
| TaskIds | You can pass multiple task Ids here to specify the appointments you want to cancel. You can retrieve task Ids through any of the get appointment APIs – |
| StatusWebhookURL | You can pass a webhook URL to post the data to. |
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Message": {
"Id": "5812945",
"IsSuccessful": true
}
}
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. |
