Bookings
Update Booking
Update an existing Booking record.
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
eBookingRepeatCycle — Repeats values
eBookingRepeatCycle — Repeats values
eRepeatedBookingUpdateAction — WhichBookingsToUpdate values
eRepeatedBookingUpdateAction — WhichBookingsToUpdate values
Request Body
Required Fields
integer
required
The Id of the Booking record to update.
integer
required
ID of the resource linked to this record.
string
required
Booking start time.
string
required
Booking end time.
integer
required
Repeat cycle. Create-only.
integer
required
Action to apply when updating or deleting bookings in a repeated series. This is the only field that can modify a series after creation.
Optional Fields
integer
ID of the floor plan desk linked to this record.
integer
ID of the coworker linked to this record.
integer
ID of the extra service linked to this record.
string
Optional notes or comments about this booking.
string
Internal notes.
boolean
Charge immediately.
boolean
Invoice immediately.
boolean
Charge the booking to the customer making it rather than their paying member (if any).
boolean
Do not use booking credit.
string
Purchase order.
string
Discount code.
string
Date/time value for last notification time.
string
ID of the google calendar associated with this record.
string
ID of the google event associated with this record.
string
ID of the office365 event associated with this record.
string
ID of the public google event associated with this record.
boolean
Tentative booking. Must be approved by an administrator before confirmed or charged. Tentative bookings still block the calendar.
string
Teams at the time of booking.
string
Tariff at the time of booking.
string
ID of the repeat series unique associated with this record.
boolean
Create a repeating booking series. Create-only: once created, only WhichBookingsToUpdate can be used to update the series. No new bookings can be added to the series.
integer
Repeat every N periods. Create-only.
string
Repeat until date. Create-only.
boolean
Repeat on Mondays. Create-only.
boolean
Repeat on Tuesdays. Create-only.
boolean
Repeat on Wednesdays. Create-only.
boolean
Repeat on Thursdays. Create-only.
boolean
Repeat on Fridays. Create-only.
boolean
Repeat on Saturdays. Create-only.
boolean
Repeat on Sundays. Create-only.
boolean
Whether reminded is enabled.
boolean
Whether mrm reminded is enabled.
number
Admin-set fixed price for the booking, regardless of what extra service (rate) is associated with it.
integer
ID of the kisi key associated with this record.
string
ID of the start scheduled job associated with this record.
string
ID of the end scheduled job associated with this record.
boolean
Whether billed is enabled.
string
Date/time value for from time local.
string
Date/time value for to time local.
string
Date/time value for invoice date local.
number
The coworker extra service price value for this booking.
boolean
Include Zoom invite.
string
The zoom event data value for this booking.
string
ID of the office365 admin event associated with this record.
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
Update Booking