TRMNL Octri Demo
POST/api/devices/{device_id}/playlist_items

Add a plugin instance to a device playlist

Adds a plugin instance to a device's playlist by creating a playlist item. Supply plugin_setting_id to identify the plugin setting to add. A 200 response returns the added playlist item.

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

1 parameter · 1 body field
device_idintegerrequired
The integer identifier of the device whose playlist to update.

The plugin setting to add to the device's playlist.

plugin_setting_idintegerrequired
Plugin setting id

3 status codes
200Returns the added playlist item, including its identifier and available plugin, configuration, presentation, and ordering details.
dataobjectoptional
401Returned when the request is unauthorized.
errorstringoptional
404Returned when the device belongs to another user.

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the device_id path parameter identifies a device belonging to another user. plugin_setting_id is required and identifies the plugin setting to add.