Plugin Settings

Rename a plugin setting or change how it refreshes

Changes the attributes of the instance itself. Its form fields are updatePluginSettingFields, its markup writeMarkup. A refresh_interval faster than the plan allows is raised to the nearest allowed value.

patch/api/plugin_settings/{id}

Request

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

Path parameters

idstring required

Plugin setting id or uuid

Request body

namestring
descriptionstring nullable
refresh_interval1440 | 720 | 480 | 360 | 240 | 120 | 60 | 30 | 15 | 10 | 5

Minutes between renders

health_notification_enabledboolean

Email the owner when the instance stops rendering

Response

Updated

Example response

{
  "data": {
    "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"
  }
}

Changes

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