---
title: "Create a new plugin setting"
method: POST
path: "/api/plugin_settings"
tags: ["Plugin Settings"]
---

# Create a new plugin setting

`POST /api/plugin_settings`

## Request

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

listPlugins gives the plugin_id to send here; getPlugin lists the fields to send updatePluginSettingFields next.

## Request body

- PluginSettingParams
  - `name` string, required
  - `plugin_id` integer, required

## Response `200`

Success

- 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
- `422`: Unprocessable Entity

---

[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)