Playlists

Show or hide several playlist items on a device at once

action_type is hide or show. To remove items use deletePlaylistItem instead.

post/api/devices/{device_id}/playlist_items/bulk

Request

  • Base URL: https://trmnl.com
  • URL: https://trmnl.com/api/devices/{device_id}/playlist_items/bulk
  • Auth: HTTP bearer

Path parameters

device_idinteger required

Device id

Request body

action_type'hide' | 'show' required
playlist_item_idsinteger[] required

Response

Applied, answering the items in the submitted order

Example response

{
  "data": [
    {
      "created_at": "2023-10-01T12:00:00Z",
      "configuration_state": "configured",
      "device_id": 1,
      "id": 1,
      "mashup_id": 1,
      "mirror": true,
      "plugin": {
        "id": 1,
        "name": "Weather",
        "keyname": "weather"
      },
      "plugin_id": 1,
      "plugin_setting": {
        "id": 1,
        "name": "My Plugin Setting",
        "description": "Upcoming train departures",
        "plugin_id": 1,
        "refresh_interval": 60,
        "icon_url": "https://trmnl-public.s3.com/qwertyasdf",
        "icon_content_type": "image/png",
        "strategy": "webhook"
      },
      "plugin_setting_id": 1,
      "rendered_at": "2023-10-01T12:00:00Z",
      "row_order": 1,
      "updated_at": "2023-10-01T12:00:00Z",
      "visible": true,
      "palette_id": "bw",
      "font_family": "classic",
      "text_scale": "large",
      "theme": "dark"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.