TRMNL Octri Demo
PATCH/api/apps/room_booking/{installation_id}/collections/{id}

Update a calendar collection

Updates a calendar collection in a room booking installation. Supply only the fields you want to change; when provided, resource_ids replaces the entire set of calendars, and cannot be used to empty the collection.

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

2 parameters · 6 body fields
installation_idstringrequired
The identifier of the room booking installation containing the collection.
idintegerrequired
The identifier of the collection to update.

The collection fields to change. Omitted fields keep their existing values.

collection_typestringoptional
The collection category: any, rooms, spaces, desks, desk_pools, parking_spaces, vehicles, equipment, people, or other.
Allowed:anyroomsspacesdesksdesk_poolsparking_spacesvehiclesequipmentpeopleother
display_layoutstringoptional
The collection display layout: list or grid.
Allowed:listgrid
namestringoptional
The collection name.
resource_idsarray<string>optional
Calendar IDs to include in the collection. When provided, this replaces the entire set and cannot be empty.
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 updated 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 collection belongs to another installation.
422Returned when an update attempts to empty the collection's calendars; the current calendars remain unchanged.

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 collection belongs to another installation, and a 422 when an update attempts to empty the collection's calendars. The installation_id path parameter must identify the installation, and the id path parameter must identify a collection in it. When supplied, collection_type must be one of the listed values, display_layout must be list or grid, and resource_ids must not be empty.