---
title: "Rename a plugin setting or change how it refreshes"
method: PATCH
path: "/api/plugin_settings/{id}"
tags: ["Plugin Settings"]
---

# Rename a plugin setting or change how it refreshes

`PATCH /api/plugin_settings/{id}`

## Request

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

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.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `description` string, nullable
  - `refresh_interval` 1440 | 720 | 480 | 360 | 240 | 120 | 60 | 30 | 15 | 10 | 5: Minutes between renders
  - `health_notification_enabled` boolean: Email the owner when the instance stops rendering

## Response `200`

Updated

- object
  - `data` PluginSetting
    - `sync` PluginSync
      - `source_kinds` string[], required
      - `upload_allowed` boolean, required
      - `reason` string, nullable
      - `action_id` string, nullable
    - `id` integer
    - `name` string
    - `description` string, nullable
    - `plugin_id` integer
    - `refresh_interval` integer, nullable: Minutes between renders
    - `health_notification_enabled` boolean
    - `icon_url` string, nullable
    - `icon_content_type` string, nullable
    - `read_only?` boolean
    - `strategy` string, nullable

## Other responses

- `401`: Unauthorized
- `404`: Plugin setting belongs to another user
- `422`: Pushes nothing to GitHub when the save is refused

---

[API](https://skmtc.dev/trmnl/apis/trmnl-api.md) · [All operations](https://skmtc.dev/trmnl/apis/trmnl-api/llms.txt) · [OpenAPI document](https://skmtc.dev/trmnl/apis/trmnl-api/revisions/66179e6d663b?raw)