Playlists

Update a playlist item

The appearance fields override the device's own for this item; null returns one to the device default. listPalettes names the palettes a device model has.

patch/api/playlists/items/{id}

Request

  • Base URL: https://trmnl.com
  • URL: https://trmnl.com/api/playlists/items/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

ID of the playlist item

Request body

visibleboolean
palette_idstring nullable
font_familystring nullable
text_scale'small' | 'regular' | 'large' | 'xlarge' | 'null' nullable
themestring nullable

Example request

{
  "palette_id": "bw",
  "font_family": "classic",
  "theme": "dark"
}

Response

item that is not an object is read as no change

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.