Update appointment status
This endpoint is deprecated. Please do not use it for new projects. The documentation remains here for legacy API consumers.
Update appointment status
To update the status of an appointment use the /appointments/{appointmentId}/status/{statusId} API endpoint.
By sending the following PUT-request you can update the status of an application
1 2 |
curl -i -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -X PUT "https://api.softgarden.io/api/rest/v2/frontend/appointments/{appointmentId}/status/{statusId}" -d "{comment}" |
with TOKEN being the user access token of the user in question. It is used to determine the validity of this request.
Beyond that, the body of the POST message can optionally contain a String, that contains a {comment} to the change of status. Post data are submitted via the -d parameter of curl.
Path parameters
Name | Description | Data Type |
---|---|---|
appointmentId | The ID of the desired appointment. | String |
statusId | The ID of the status to set. For possible status IDs please see the AppointmentStatus type. | String |
Query parameters
– none –
Response values
Upon | Returned value | Description |
---|---|---|
success | boolean | ‘true’ when the status was set correctly, ‘false’ otherwise. |
failure | 500 – INTERNAL SERVER ERROR | When an error appears while processing your request. |
authorization error | 401 / 403 | See here for details. |
Example return value
1 |
true |