Bookings are short-term reservation of resource. Bookings can reserve any resource, such as Meeting Room, Hot desk, Private Office, etc.
The API allows you to create, delete, and update bookings.
Here is the list of most properties the booking object has:
Booking
| Property | Type | Required | Description |
|---|---|---|---|
| start.dateTime | date | true | Start datetime of the booking in ISO date time format. |
| end.dateTime | date | true | End datetime of the booking in ISO date time format. |
| serviceSlots,before | number | false | Allows you to create a buffer slot before the booking takes place. The time is measure in minutes. |
| serviceSlots.after | number | false | Allows you to create a buffer slot after the booking takes place. The time is measure in minutes. |
| timezone | string | readonly | The booking resource timezone. |
| source | string | false | The origin/source of the booking. |
| summary | string | false | Booking title/summary. |
| resourceId | Resource | true | Reference to the booked resource. |
| plan | Rates | readonly | Reference to the resource rate used for the booking. |
| team | Company | true (if member isn't entered) | Reference to the company. |
| member | Member | true (if team isn't entered) | Reference to the member. |
| description | string | false | Long description of the booking. |
| tentative | boolean | false | True if the booking is not confirmed. Tentative booking are not charged. |
| free | boolean | false | True if the booking is marked as free. If create a booking marked as free, no fees will be added for it. |
| fees | array | readonly | Array of items describing how the booking will be charged for. Described below as BookingFee. |
| extras | object | readonly | Dictionary with keys the IDs of the extras to add to the booking and values - the quantity of the extra |
| visitors | array | false | Can be populated with ids of visitors created using this endpoint. |
| members | array | false | Can be populated with ids of members from the same company, if there's a "team" associated with the booking. |
| canceled | boolean | readonly | Whether the booking got canceled or not. It also can be passed when calling the /summary endpoint. |
| recurrence.rrule | string | false | Determines if the booking is recurring. The "FREQ" can be daily/weekly/monthly and "UNTIL" is the end date of recurrence. Example: "FREQ=DAILY;UNTIL=20220117T230000Z" |
| customPrice | number | false | Used if you want to set a custom price for the booking and ignore the standard rate. Can also be used a in PUT request to update an existing booking. |
| createdAt | date | readonly | The date when the booking has been created. |
| createdBy | id | readonly | The user that created the booking. |
| modifiedAt | date | readonly | The user that did the last modification to the booking. If no update is made this field will match the createdBy field. |
| modifiedBy | id | readonly | The user that did the last modification to the booking. Before the first modification, this field equals to the createdBy field. |