Skip to main content

Cancel booking

DELETE 
/v1/partner/bookings/:booking_id

Cancels an existing booking identified by its unique ID. Optionally allows specifying a reason for cancellation.

Token scope:

{'scope': 'write:bookings'}

Request​

Path Parameters

    booking_id Booking Idrequired

Body

    cancellation_reason Cancellation Reason (string)

Responses​

Successful operation. Returns the cancelled booking object.

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...