Skip to main content
PUT
Update Booking
Updates an existing Booking record. You must include the Id of the record to update along with all required fields.

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 Booking-Edit role.

Enums

Request Body

Required Fields

integer
required
The Id of the Booking record to update.
integer
required
ID of the resource being reserved; it determines the booking location and availability rules..
string
required
Booking start date and time in UTC..
string
required
Booking end date and time in UTC; it must be after FromTime..
integer
required
Recurrence cycle: Daily, Weekly, Monthly, Yearly, FirstOfMonth, SecondOfMonth, ThirdOfMonth, FourthOfMonth, or LastOfMonth..
integer
required
For a recurring booking update, selects whether to update this booking, future bookings, all bookings, not-charged bookings, or perform the corresponding delete or charge-reversal action..

Optional Fields

integer
Optional ID of the floor-plan unit assigned within the selected resource. The unit must be connected to this resource.
integer
Optional ID of the customer this booking is for..
integer
Optional ID of the rate used to price this booking. Set it only to a rate linked to the selected resource’s ResourceType. When no rate is provided, the system calculates an applicable rate automatically..
string
Customer-facing notes for the booking..
string
Internal staff notes recorded when the booking is created..
boolean
Whether to charge the booking immediately when it is created or updated..
boolean
Whether to generate an invoice for the booking immediately..
boolean
Whether the selected customer receives the booking charge. When false, the customer’s team-paying member, if any, is the billing party..
boolean
Whether to prevent available customer booking credit from being used for this booking..
string
Optional customer purchase-order reference for the booking..
string
Optional discount code applied when the booking price is calculated..
string
System-maintained UTC timestamp of the last booking notification..
string
Internal Google Calendar identifier maintained by calendar synchronization..
string
Internal Google Calendar event identifier maintained by calendar synchronization..
string
Internal Microsoft 365 calendar event identifier maintained by synchronization..
string
Internal public Google Calendar event identifier maintained by synchronization..
boolean
Whether the booking is tentative and still requires confirmation. Customer bookings for resources requiring confirmation are created as tentative; administrators can create tentative bookings for any resource..
string
System snapshot of the customer’s team memberships when the booking was made..
string
System snapshot of the customer’s plan when the booking was made..
string
System-generated identifier linking all bookings in the same recurrence series; use it to find and update all bookings in that series..
boolean
Whether to create a recurring series from this booking..
integer
Optional positive recurrence interval; for example, 2 with Weekly repeats every two weeks..
string
Optional final UTC date and time for creating occurrences in the recurrence series..
boolean
Whether a weekly recurring booking includes Mondays..
boolean
Whether a weekly recurring booking includes Tuesdays..
boolean
Whether a weekly recurring booking includes Wednesdays..
boolean
Whether a weekly recurring booking includes Thursdays..
boolean
Whether a weekly recurring booking includes Fridays..
boolean
Whether a weekly recurring booking includes Saturdays..
boolean
Whether a weekly recurring booking includes Sundays..
boolean
System flag showing whether the standard booking reminder has been sent..
boolean
System flag showing whether the standard booking notification has been sent..
boolean
System flag showing whether an MRM reminder has been sent..
number
Optional total price override for this booking, before normal rate calculation..
integer
Internal Kisi access-control key identifier for this booking..
string
Internal scheduled-job identifier for the booking start..
string
Internal scheduled-job identifier for the booking end..
boolean
Internal billing-processing state for this booking..
string
System-maintained local-time representation of FromTime..
string
System-maintained local-time representation of ToTime..
string
System-maintained local-time representation of InvoiceDate..
number
System-calculated price from the customer’s applicable rate entitlement..
boolean
Whether to include a Zoom meeting invitation for this booking..
string
Internal Zoom event payload maintained by the integration..
string
Internal Microsoft 365 administrator calendar event identifier maintained by synchronization..
string
UTC date and time when the customer checked in for this booking..
string
UTC date and time when the customer checked out from this booking..

Children

object[]
Products to include with this booking
object[]
Visitors to add to this booking

Code Examples

Response

200

integer
HTTP status code. 200 on success.
string
A human-readable message confirming the update.
object
Contains the Id of the updated record.
boolean
true if the booking was updated successfully.
array
null on success.
Example Response

400

string
A summary of the validation error(s), in the format PropertyName: error message.
any
null on validation failure.
object[]
Array of validation errors.
boolean
false when the request fails validation.
Example Response