1. Updating Pending or Failed Appointments
For appointments with a status of ‘pending’ or ‘failed’, you can update any attribute of the appointment.Parameter | Type | Required | Description |
---|---|---|---|
Any appointment attribute | varies | No | Any attribute of the appointment can be updated. All fields are optional. |
2. Updating Scheduled Appointments
For appointments with a status of ‘scheduled’, you can only update the status or note property.Parameter | Type | Required | Description |
---|---|---|---|
status | string | No | Must be one of the available statuses associated with the linked account. You can find the available statuses by using our GET /visit-statuses endpoint |
note | string | No | A note associated with the appointment. This is not a progress note or addition to the patient chart. This is primarily used for admin (eg. “patient might be 5 minutes late”). |
Example Request for Updating a Pending/Failed Appointment
Example Response
Authorizations
Path Parameters
The appointment ID
Body
application/json
Updates for pending/failed appointments
Response
200 - application/json
Successful response
The response is of type object
.