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

Add an iCal calendar

Creates a read-only iCal calendar for a room booking installation. Supply name and ics_url; events from the feed appear on the screen, while bookings must be made in the source calendar. Google and Microsoft calendars require the owner to sign in through the browser.

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

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

Details for the iCal calendar to add.

capacityintegeroptional
The capacity of the calendar.
ics_urlstringrequired
http, https or webcal
namestringrequired
The name to display for the calendar.
show_booking_qrbooleanoptional
Whether to show a booking QR code.
show_company_logobooleanoptional
Whether to show the company logo.
timezonestringoptional
IANA name; the installation time zone when left out

5 status codes
200Returns a `data` object for the created calendar, including its identifier, name, iCal feed URL, capacity, booking details, and device bindings.
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 calendar creation request is refused.

Error handling

name and ics_url are required, and ics_url must use http, https, or webcal. A 401 is returned when the request is unauthorized, and a 402 is returned while billing is locked until the subscription is settled. A 404 is returned when the installation_id path parameter belongs to another user, and a 422 indicates the calendar request was refused.