TRMNL Octri Demo
POST/api/apps/room_booking/{installation_id}/collections

Create a calendar collection

Creates a calendar collection for a room booking installation. Include at least one calendar ID in resource_ids; collection_type defaults to rooms and display_layout defaults to list when omitted. The response contains the created collection and its public booking details.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 6 body fields
installation_idstringrequired
The identifier of the room booking installation to add the collection to.

The calendar collection to create. name and resource_ids are required, and resource_ids must contain at least one calendar ID.

collection_typestringoptional
rooms when left out
Allowed:anyroomsspacesdesksdesk_poolsparking_spacesvehiclesequipmentpeopleother
display_layoutstringoptional
list when left out
Allowed:listgrid
namestringrequired
The name of the calendar collection.
resource_idsarray<string>required
Calendar ids, as listRoomBookingCalendars answers them
show_booking_qrbooleanoptional
Whether to show a booking QR code for the collection.
show_company_logobooleanoptional
Whether to show the company logo for the collection.

5 status codes
200Returns the created collection in `data`, including its ID, name, collection type, display layout, resource IDs, bound devices, and public booking details.
dataobjectoptional
401Returned when the request is unauthorized.
errorstringoptional
402Returned when billing is locked until the subscription is settled.
404Returned when the installation belongs to another user.
422Returned when the requested layout is not available for the collection.

Error handling

A 401 is returned for an unauthorized request, a 402 when billing is locked until the subscription is settled, a 404 when the installation belongs to another user, and a 422 when the requested layout is not available for the collection. The installation_id path parameter must identify a room booking installation you can access. Include name and at least one calendar ID in resource_ids; collection_type must be one of the listed values, and display_layout must be list or grid.