Update Booking status
PATCH/v1/partner/bookings/:booking_id
Updates the status of a booking to any of the booking status types listed in the booking status section of this document. Accepts the below statuses:
cancelled: The booking has been cancelled by patient or by staff.
reserved: The booking was reserved online or booked ahead of time by staff.
discharged: The patient has completed their visit and their visit is discharged.
no_show: The patient did not appear for their scheduled appointment.
confirmed: The booking has been confirmed and is scheduled to occur.
checked_in: The patient has arrived at the location and checked in for their appointment.
in_exam_room: The patient is currently in the exam room receiving care.
Token scope:{'scope': 'write:bookings'}
Request​
Path Parameters
The unique identifier of the booking to update
- application/json
Body
required
The new status to set for the booking
Responses​
- 200
- 422
Successful Response
- application/json
- Schema
- Example (from schema)
Schema
{
"address_city": "string",
"address_state": "string",
"address_street": "string",
"address_street_secondary": "string",
"address_zip": "string",
"appointment_date": "string",
"birth_date": "string",
"birth_sex": "string",
"custom_booking_management_url": "string",
"email": "string",
"emr_booking_id": "string",
"first_name": "string",
"gender": "string",
"id": 0,
"is_walk_in": true,
"last_name": "string",
"location_id": 0,
"paperwork_status": "string",
"phone": "string",
"reason": "string",
"status": "string"
}
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
- MOD1
- MOD2
]
]
detail
object[]
loc
object[]
required
anyOf
string
integer
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}