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

Book a room

Creates a booking on a room calendar as its owner. Provide starts_at and ends_at as ISO 8601 date-time values; times without a zone are interpreted in the calendar's time zone. iCal calendars are read-only, and overlapping confirmed bookings cannot be booked.

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

2 parameters · 3 body fields
installation_idstringrequired
The unique identifier of the room booking installation.
idstringrequired
The unique identifier of the calendar to book.

Booking details. Provide both starts_at and ends_at.

ends_atstringrequired
The booking end time as an ISO 8601 date-time. A time without a zone is interpreted in the calendar's time zone.
starts_atstringrequired
The booking start time as an ISO 8601 date-time. A time without a zone is interpreted in the calendar's time zone.
titlestringoptional
The title of the booking.

6 status codes
200Returns the created booking, including its identifier, title, start and end times, status, and source.
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.
409Returned when the requested slot overlaps a confirmed booking.
422Returned when the booking end time is before its start time.

Error handling

A 401 is returned when the request is unauthorized, and a 402 when billing is locked until the subscription is settled. A 404 is returned when the installation belongs to another user; the installation_id path parameter and id path parameter must identify the intended room booking installation and calendar. A 409 is returned when the requested slot overlaps a confirmed booking, and a 422 when ends_at is before starts_at; provide both times as ISO 8601 date-time values.