CancelledBookings
Create CancelledBooking
Create a new CancelledBooking record.
POST
A CancelledBooking is a read-only snapshot of a booking that was removed from the calendar. When a booking is cancelled, the system preserves its details — resource, coworker, time range, price, and cancellation metadata — so they remain available for reporting and auditing.
Cancelled bookings cannot be created or modified through the API; they are generated automatically when an active
Booking is cancelled. Use list and get to query cancellation history.
The CancellationReason field indicates why the booking was removed. Possible reasons include the customer no longer needing the booking, cost concerns, rebooking for a different time, failure to pay upfront, automated cancellation due to not checking in, and others.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CancelledBooking-Create role.Enums
eBookingCancellationReason
eBookingCancellationReason
| Value | Name |
|---|---|
| 0 | Unknown |
| 1 | NoLongerNeeded |
| 2 | TooExpensive |
| 3 | BadPreviousExperience |
| 4 | RebookedForADifferentTime |
| 5 | FailedToPayUpfront |
| 6 | Integration |
| 7 | Other |
| 8 | NotCheckedIn |
| 9 | MarketPlace |
Request Body
Required Fields
Resource Id.
Booking start time.
Booking end time.
Date and time when the booking was cancelled.
Optional Fields
Floor Plan Desk Id.
Coworker Id.
Extra Service Id.
Notes.
Internal Notes.
Charge Now.
Invoice Now.
Invoice This Coworker.
Do Not Use Booking Credit.
Purchase Order.
Discount Code.
Last Notification Time.
Google Calendar Id.
Google Event Id.
Office365Event Id.
Public Google Event Id.
Tentative booking. Must be approved by an administrator before confirmed or charged. Tentative bookings still block the calendar.
Online.
Teams At The Time Of Booking.
Tariff At The Time Of Booking.
Repeat Series Unique Id.
Repeat Booking.
Repeats. See
eBookingRepeatCycle enum above.Which Bookings To Update. See
eRepeatedBookingUpdateAction enum above.Repeat Every.
Repeat Until.
Repeat On Mondays.
Repeat On Tuesdays.
Repeat On Wednesdays.
Repeat On Thursdays.
Repeat On Fridays.
Repeat On Saturdays.
Repeat On Sundays.
Reminded.
Mrm Reminded.
Override Price.
Whether the booking had been charged. When true, a charge (CoworkerExtraService) had been posted to the customer account.
Invoice Date.
Booking Number.
Kisi Key Id.
Start Scheduled Job Id.
End Scheduled Job Id.
Billed.
From Time Local.
To Time Local.
Invoice Date Local.
Coworker Invoice Id.
Coworker Invoice Number.
Coworker Invoice Paid.
Coworker Invoice Draft.
Coworker Invoice Void.
Coworker Invoice Credit Note.
Coworker Extra Service Ids.
Coworker Extra Service Price.
Coworker Extra Service Currency Code.
Coworker Extra Service Charge Period.
Coworker Extra Service Total Uses.
Include Zoom Invite.
Zoom Event Data.
Checked In At.
Cancel If Not Paid.
Cancel If Not Checked In.
Max Occupancy.
Last Minute Price Adjustment.
Dynamic Price Adjustment.
Price Factor Last Minute.
Price Factor Demand.
Office365Admin Event Id.
Reason the booking was cancelled, e.g. NoLongerNeeded, TooExpensive, or NotCheckedIn. See
eBookingCancellationReason? enum above.Name or identifier of the user who cancelled the booking.
Additional free-text details explaining the cancellation reason.
Booking price.
Original Booking Id.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the cancelledbooking was created successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response