TRMNL Octri Demo
PUT/api/playlists/items/{item_id}/schedule

Replace a playlist item's display schedule

Replaces the display schedule for a playlist item. Supply week_schedules and, when needed, a date_range; an empty week_schedules array with no date range clears the schedule so the item always displays.

1 parameter · 2 body fields
item_idintegerrequired
The integer identifier of the playlist item whose schedule to replace.

The replacement schedule. week_schedules is required; an empty array with no date_range clears the schedule.

date_rangeobjectoptional
Only display between these dates. Null when no dates are set
week_schedulesarray<object>required
Weekly display windows. Each window has `start_time` and `end_time` in HH:MM format from 00:00 to 23:59, and `week_days` values from 0 (Sunday) through 6 (Saturday).

4 status codes
200Returns the replaced schedule, including whether the item is always active, its date range, and its weekly schedules. An empty weekly schedule with no date range clears the schedule so the item always displays.
dataobjectoptional
401Returned when the request is not authenticated.
errorstringoptional
404Returned when the playlist item belongs to another user.
422Returned when a schedule time does not use the required HH:MM format.

Error handling

A 401 is returned when the request is not authenticated. A 404 is returned when the playlist item belongs to another user. The item_id path parameter identifies the playlist item to update; week_schedules is required, and schedule times must use the HH:MM format or the request is rejected with a 422.