TRMNL Octri Demo
POST/api/plugin_settings

Create a plugin setting

Creates a plugin setting for a plugin. Supply the required name and plugin_id; use listPlugins to find the plugin ID. After creation, use getPlugin to find the fields to send to update the setting.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

The plugin setting to create.

namestringrequired
The name for the new plugin setting.
plugin_idintegerrequired
The integer ID of the plugin for this setting.

3 status codes
200Returns the created plugin setting, including its ID, name, plugin ID, and other setting details.
dataobjectoptional
401Returned when authentication is missing or invalid.
errorstringoptional
422Returned when the request cannot be processed.
errorstringoptional

Error handling

A 401 is returned when authentication is missing or invalid. Both name and plugin_id are required; a 422 is returned when the request cannot be processed.