Bulk Update Appointment Timings
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Updates the timings of multiple tasks in one go.
- Pass the “UserTaskId”, “FromDate” and “ToDate” for each appointment you want to update.
- To post the data to a URL of your choice, use the “StatusWebhookURL” parameter.
API URL
URL
POST
https://{host}/v2/Task.svc/BulkUpdateAppointmentTime?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"TaskList": [
{
"UserTaskId": "0aa0b97c-a507-11e8-a43f-02742c1c8abe",
"FromDate": "2018-09-29 12:30:00",
"ToDate": "2018-09-29 12:30:00"
},
{
"UserTaskId": "22a3a4b4-a480-11e8-a43f-02742c1c8abe",
"FromDate": "2018-09-29 12:30:00",
"ToDate": "2018-09-29 12:30:00"
}
],
"StatusWebhookURL": "http://track.crm4b2c.com/l/PostDataToFile.aspx"
}
Request Parameters
| Parameter | Description |
|---|---|
| UserTaskId | Task Id for the appointment. You can retrieve this through any of the get appointment APIs – |
| FromDate | The new start date and time you want to update the appointment to in UTC (YYYY-MM-DD HH:MM:SS). |
| ToDate | The new end date and time you want to update the appointment to in UTC (YYYY-MM-DD HH:MM:SS). |
| StatusWebhookURL | You can pass a webhook URL to post the data to here. |
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. |
