Modules are reusable components that can be used to customize and add functionality to your Portals. Currently, BookingModule is the only available Module.
| Type | Description |
|---|---|
BookingModule | Defines a booking system where end-users can submit and manage Bookings to book Spaces and resources. |
Create a BookingModule
Creates a new BookingModule based on the provided fields.
Note: Custom fields in the bookingForm should be provided without id fields. The system will assign ids during creation and return them in the response.
Request Body
orgIdstring · uuid · requiredThe id of the
Organizationthat owns thisBookingModule.namestring · requiredThe display name of the
BookingModule.adminIdstring · uuid · requiredThe id of the
Userwho receives email notifications related to thisBookingModule. ThisUserwill also have their email address included in the footer of automated emails sent to bookers.portalIdsstring[] · requiredThe ids of
Portalsassociated with thisBookingModule.configobject · requiredGlobal configuration settings for the
BookingModule.aboutobject · requiredConfiguration of the About page of the
BookingModule.calendarobject · requiredConfiguration of the Calendar page of the
BookingModule.bookingFormobject · requiredConfiguration of the booking form of the
BookingModule.Important: When creating a
BookingModule, custom fields should be provided WITHOUTidfields. The system will assign ids during creation. The createdBookingModulewill include ids for all custom fields.spacesobject · requiredA map of
Spaceids bookable in theBookingModuleto their configuration.A
Spacecan only be included if its parentVenueis present in thevenueIdsfield.
Responses
The newly created BookingModule.
bookingModuleobject · required
Update a BookingModule
Updates the specified BookingModule by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change a BookingModule's id.
Custom Field Updates: Use createdCustomFields (without ids), updatedCustomFields (with ids as keys), and deletedCustomFieldIds to manage custom fields.
Space Updates: Use addedSpaces, updatedSpaces (with space ids as keys), and removedSpaceIds to manage Space configurations.
path Parameters
bookingModuleIdstring · uuid · requiredThe id of the
BookingModule.
Request Body
namestringThe display name of the
BookingModule.adminIdstring · uuidThe id of the
Userwho receives email notifications related to thisBookingModule. ThisUserwill also have their email address included in the footer of automated emails sent to bookers.configobjectPartial updates to global configuration settings.
aboutobjectPartial updates to the About page configuration.
calendarobjectPartial updates to the Calendar page configuration.
bookingFormobjectPartial updates to booking form configuration.
addedSpacesobjectNew
Spacesand their configurations to add, keyed bySpaceid.A
Spacecan only be included if its parentVenueis present in thevenueIdsfield.updatedSpacesobjectPartial updates to existing
Spaceconfigurations, keyed bySpaceid.removedSpaceIdsstring[]Ids of
Spacesto remove.
Responses
The updated BookingModule.
bookingModuleobject · required