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

Apply typed changes to plugin configuration

Updates a plugin setting's typed configuration by applying changes atomically. Provide the current revision and a changes array; if any change is invalid, no fields are saved. A 409 response indicates that the revision is stale.

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

1 parameter · 2 body fields
plugin_setting_idintegerrequired
The identifier of the plugin setting whose configuration to update.

The current configuration revision and the typed changes to apply atomically.

changesarray<object>required
The typed changes to apply. Provide at most 200 entries; each entry requires `op` and `path`.
revisionstringrequired
The current revision of the configuration being updated.

3 status codes
200Returns confirmation that the configuration was saved.
409Returned when the supplied configuration revision is stale.
422Returned when a typed change is invalid; no fields are saved.

Error handling

A 409 is returned when the supplied revision is stale. revision and changes are required; changes can contain at most 200 entries, each requiring an op of set, unset, or clear_secret and a path beginning with /values/; a 422 is returned when a typed change is invalid, and no fields are saved. The plugin_setting_id path parameter must identify the plugin setting to update.