TRMNL Octri Demo
PATCH/api/playlists/items/{id}

Update a playlist item

Updates appearance settings for a playlist item, overriding the device's own settings for that item. Supply only the fields you want to change; set an appearance field to null to return it to the device default. Use listPalettes to find the palettes available for a device model.

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

1 parameter · 5 body fields
idintegerrequired
The identifier of the playlist item to update.

Optional appearance settings for the playlist item. Supplied values override the device's settings for this item; null returns an appearance field to the device default.

font_familystringoptional
The font family to use for this playlist item.
palette_idstringoptional
The identifier of the palette to use for this playlist item.
text_scalestringoptional
The text scale: small, regular, large, xlarge, or null.
Allowed:smallregularlargexlargenull
themestringoptional
The theme to use for this playlist item.
visiblebooleanoptional
Whether the playlist item is visible.

3 status codes
200Returns the updated playlist item, including its current appearance settings and associated device and plugin details.
dataobjectoptional
401Returned when the request is unauthenticated.
errorstringoptional
422Returned when an appearance value cannot be shown by the device.

Error handling

A 401 is returned when the request is unauthenticated. A 422 is returned when the device cannot show an appearance value; text_scale accepts small, regular, large, xlarge, or null. The id path parameter must identify the playlist item to update.