Skip to main content

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

    booking_id Booking Idrequired

    The unique identifier of the booking to update

Body

required

    status Status (string)required

    The new status to set for the booking

Responses​

Successful Response

Schema

    address_city Address City (string)
    address_state Address State (string)
    address_street Address Street (string)
    address_street_secondary Address Street Secondary (string)
    address_zip Address Zip (string)
    appointment_date Appointment Date (string)required
    birth_date Birth Date (string)required
    birth_sex Birth Sex (string)
    custom_booking_management_url Custom Booking Management Url (string)
    email Email (string)required
    emr_booking_id Emr Booking Id (string)
    first_name First Name (string)required
    gender Gender (string)
    id Id (integer)required
    is_walk_in Is Walk In (boolean)required
    last_name Last Name (string)required
    location_id Location Id (integer)required
    paperwork_status Paperwork Status (string)required
    phone Phone (string)required
    reason Reason (string)required
    status Status (string)required
Loading...