TRMNL Octri Demo
POST/api/plugin_settings/{id}/data

Update webhook plugin setting data

Updates the stored data for a webhook plugin setting. Supply merge_variables as a JSON object containing the variables to store. A successful response may include processing when a transform runs out of band and the variables are not yet final.

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

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

Data to store for the webhook plugin setting.

merge_variablesunknownrequired
A JSON object containing the merge variables to store.

4 status codes
200Returns `error` as null when the write succeeds and includes the stored `merge_variables`. Includes `processing` when a transform runs out of band and the variables are not yet final.
errorstringrequired
Null when the write succeeded
merge_variablesobjectrequired
The variables now stored
processingstringoptional
Present when a transform runs out of band, so the variables are not final
401Returned when the request is unauthorized.
errorstringoptional
404Returned when the plugin setting is not found.
errorstringoptional
422Returned when the plugin setting's data cannot be modified.
errorstringoptional

Error handling

A 401 is returned when the request is unauthorized, and a 404 is returned when the plugin setting is not found. A 422 is returned when the data cannot be modified. The id path parameter must identify a plugin setting, and merge_variables must be a JSON object.