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

Show or hide playlist items on a device

Shows or hides multiple playlist items on a device in one request. Supply action_type as hide or show and list the target item identifiers in playlist_item_ids; use the playlist-item deletion operation to remove items.

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

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

The action to apply and the playlist item identifiers to update.

action_typestringrequired
The action to apply to the items: `hide` or `show`.
Allowed:hideshow
playlist_item_idsarray<integer>required
The integer identifiers of the playlist items to update.

4 status codes
200Returns the updated playlist item objects in the same order as the submitted identifiers.
dataarray<object>optional
401Returned when the request is not authenticated.
errorstringoptional
404Returned when the device belongs to another user.
422Returned when one or more submitted playlist item identifiers do not belong to the device.

Error handling

A 401 is returned when the request is not authenticated. A 404 is returned when the device belongs to another user. The action_type and playlist_item_ids fields are required, and action_type must be hide or show; a 422 is returned if any listed item does not belong to the device identified by the device_id path parameter.