TRMNL Octri Demo
PATCH/api/plugin_settings/{plugin_setting_id}/settings

Update plugin setting fields

Updates the fields stored in a plugin setting. Supply the fields object with the setting values you want to change. Field values must be strings.

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

1 parameter · 1 body field
plugin_setting_idstringrequired
The plugin setting's ID or UUID whose fields you want to update.

The plugin setting fields to update; provide the fields object.

fieldsobjectrequired
An object of plugin setting field names and values. Values must be strings.

4 status codes
200Returns an object indicating whether the settings update succeeded and listing any warnings.
dataobjectoptional
401Returned when authentication is missing or invalid.
errorstringoptional
404Returned when the plugin setting UUID is unknown.
422Returned when the fields object contains non-string values.

Error handling

A 401 is returned when authentication is missing or invalid. The plugin_setting_id path parameter must identify an existing plugin setting; a 404 is returned for an unknown UUID. The fields object is required, and a 422 is returned when it contains non-string field values.