Bulk Update Appointment Timings by Hours
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Postpones multiple appointments by any number of hours.
- Pass the “TaskIds” of the appointments you want to update.
- Specify the number of hours you want to update the appointments by in the “Duration” parameter.
Note: The appointments will be postponed by the number of hours you pass.
API URL
URL
POST
https://{host}/v2/Task.svc/BulkUpdateAppointmentTime/ReScheduleByHours?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"TaskIds": ["95a2bfd9-89bf-11e8-8266-06ee26114d5a","53a8b58d-cd37-11e8-ae91-06ee26114d5a","4aaa63a0-cd37-11e8-ae91-06ee26114d5a"],
"Duration": 1,
"StatusWebhookURL": "https://webhook.site/cc89cdd2-36b3-4b7f-b1d8-471d3e390c6a"
}
Request Parameters
| Parameter | Description |
|---|---|
| TaskIds | You can pass multiple task Ids here to specify the appointments you want to update. You can retrieve task Ids through any of the get appointment APIs – |
| Duration | The number of hours you want to postpone the appointment by. |
| 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. |
