TRMNL Octri Demo
PATCH/api/plugin_settings/{id}

Update a plugin setting

Updates attributes of a plugin setting, such as its name, description, notification setting, or refresh interval. Supply only the attributes you want to change; use the configuration endpoint for form fields and the markup endpoint to write markup. If refresh_interval is faster than the plan allows, it is raised to the nearest allowed value.

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

1 parameter · 4 body fields
idstringrequired
The plugin setting's ID or UUID.

Plugin setting attributes to update. Supply the fields you want to change.

descriptionstringoptional
A description of the plugin setting.
health_notification_enabledbooleanoptional
Email the owner when the instance stops rendering
namestringoptional
The plugin setting's name.
refresh_intervalintegeroptional
Minutes between renders
Allowed:1440720480360240120603015105

4 status codes
200Returns the updated plugin setting, including its name, description, notification setting, refresh interval, and other setting attributes.
dataobjectoptional
401Returned when the request is unauthorized.
errorstringoptional
404Returned when the plugin setting belongs to another user.
422Returned when the save is refused; no changes are pushed to GitHub.

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the plugin setting belongs to another user. A 422 is returned when the save is refused, and nothing is pushed to GitHub. The id path parameter must identify a plugin setting belonging to the authenticated user. refresh_interval must be one of 1440, 720, 480, 360, 240, 120, 60, 30, 15, 10, or 5 minutes; intervals faster than the plan allows are raised to the nearest allowed value.