TRMNL Octri Demo
PATCH/api/apps/room_booking/{installation_id}/settings

Update room booking installation settings

Updates settings for a room booking installation. Supply only the settings you want to change; omitted keys keep their current values, and show_company_logo only switches uploaded logos on or off.

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

1 parameter · 8 body fields
installation_idstringrequired
The unique identifier of the room booking installation whose settings you want to update.

Settings to change for the room booking installation. Omitted keys keep their current values.

daily_public_booking_url_rotationbooleanoptional
Whether to rotate the public booking URL daily.
dark_modebooleanoptional
Whether to use dark mode.
public_bookingsbooleanoptional
Booking with TRMNL
show_company_logobooleanoptional
Whether to show the uploaded company logo; this setting switches the logo on or off but does not upload it.
time_formatstringoptional
null detects it from the time zone
Allowed:null24_hour12_hour
timezonestringoptional
IANA name for every calendar without its own; null follows the owner
walk_up_booking_window_daysintegeroptional
Number of days in the walk-up booking window: 1, 2, 7, or 30.
Allowed:12730
walk_up_calendarbooleanoptional
Upcoming bookings on the public booking page

4 status codes
200Returns a `data` object containing the updated installation settings, including booking options, display preferences, time format, time zone, and logo attachment status.
dataobjectoptional
401Returned when the request is unauthorized.
errorstringoptional
404Returned when the installation belongs to another user.
422Returned when the specified time zone does not exist.

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the installation_id path parameter belongs to another user. A 422 is returned when timezone names a time zone that does not exist; time_format must be null, 24_hour, or 12_hour, and walk_up_booking_window_days must be 1, 2, 7, or 30.