Bookings
Create Booking
Create a new Booking record.
POST
Create Booking
A Booking is a reservation for a specific
Resource and, optionally, for a customer (CoworkerId) and a desk or unit in the floor plan (FloorPlanDeskId).
Charging vs Invoicing — When a booking is charged (confusingly labelled Invoiced in the booking entity), a charge is posted to the customer account as a CoworkerExtraService with the calculated price. If the booking has no fixed rate (ExtraServiceId = null), Nexudus calculates the rate automatically based on the resource type, booking parameters and customer. A booking is actually invoiced when the CoworkerExtraService associated with it is invoiced.
InvoiceThisCoworker = truemeans the booking is charged to the customer making it rather than their paying member (if any).Tentativebookings must be approved by an administrator before being confirmed or charged. They still block the calendar.Onlinebookings are those made via the portal or the app.
RepeatBooking and all repeat-configuration fields (Repeats, RepeatEvery, RepeatUntil, RepeatOn*) are create-only. Once a booking series is created, only WhichBookingsToUpdate can be used to update or delete bookings in the series. No new bookings can be added to an existing series.
Pricing overrides — OverridePrice lets an admin set a fixed price for the booking, regardless of what extra service (rate) is associated with it.
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-Create role.Enums
eBookingRepeatCycle — Repeats values
eBookingRepeatCycle — Repeats values
| Value | Name |
|---|---|
| 1 | Daily |
| 2 | Weekly |
| 3 | Monthly |
| 4 | Yearly |
| 5 | FirstOfMonth |
| 6 | SecondOfMonth |
| 7 | ThirdOfMonth |
| 8 | LastOfMonth |
| 9 | FourthOfMonth |
eRepeatedBookingUpdateAction — WhichBookingsToUpdate values
eRepeatedBookingUpdateAction — WhichBookingsToUpdate values
| Value | Name |
|---|---|
| 1 | UpdateThisBookingOnly |
| 2 | UpdateFutureBookingsOnly |
| 3 | UpdateAllBookings |
| 4 | UpdateNotChargedBookings |
| 5 | DeleteAllBookings |
| 6 | DeleteBookingsAfterThis |
| 7 | DeleteNotChargedBookings |
| 8 | RevertAllCharges |
Request Body
Required Fields
ID of the resource linked to this record.
Booking start time.
Booking end time.
Repeat cycle. Create-only. Defaults to
eBookingRepeatCycle.Weekly.Action to apply when updating or deleting bookings in a repeated series. This is the only field that can modify a series after creation. Defaults to
eRepeatedBookingUpdateAction.UpdateThisBookingOnly.Optional Fields
ID of the floor plan desk linked to this record.
ID of the coworker linked to this record.
ID of the extra service linked to this record.
Optional notes or comments about this booking.
Internal notes.
Charge immediately.
Invoice immediately.
Charge the booking to the customer making it rather than their paying member (if any).
Do not use booking credit.
Purchase order.
Discount code.
Date/time value for last notification time.
ID of the google calendar associated with this record.
ID of the google event associated with this record.
ID of the office365 event associated with this record.
ID of the public google event associated with this record.
Tentative booking. Must be approved by an administrator before confirmed or charged. Tentative bookings still block the calendar.
Teams at the time of booking.
Tariff at the time of booking.
ID of the repeat series unique associated with this record.
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.
Repeat every N periods. Create-only.
Repeat until date. Create-only.
Repeat on Mondays. Create-only.
Repeat on Tuesdays. Create-only.
Repeat on Wednesdays. Create-only.
Repeat on Thursdays. Create-only.
Repeat on Fridays. Create-only.
Repeat on Saturdays. Create-only.
Repeat on Sundays. Create-only.
Whether reminded is enabled.
Whether mrm reminded is enabled.
Admin-set fixed price for the booking, regardless of what extra service (rate) is associated with it.
ID of the kisi key associated with this record.
ID of the start scheduled job associated with this record.
ID of the end scheduled job associated with this record.
Whether billed is enabled.
Date/time value for from time local.
Date/time value for to time local.
Date/time value for invoice date local.
The coworker extra service price value for this booking.
Include Zoom invite.
The zoom event data value for this booking.
ID of the office365 admin event associated with this record.
Children
Products to include with this booking
Visitors to add to this booking
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 booking 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
Create Booking