TRMNL Octri Demo
PUT/api/plugin_settings/{plugin_setting_id}/markup/{size}

Replace markup for a plugin setting

Replaces markup for a plugin setting at a specified size. Supply content and choose a size from the supported markup types, including canvas and transform options. A 200 response confirms the markup was written successfully.

2 parameters · 1 body field
plugin_setting_idstringrequired
The plugin setting's ID or UUID.
sizestringrequired
The markup size to write: `markup_full`, `markup_half_horizontal`, `markup_half_vertical`, `markup_quadrant`, `markup_shared`, `tidbyt_canvas`, `vestaboard_canvas`, or `transform_js`.
Allowed:markup_fullmarkup_half_horizontalmarkup_half_verticalmarkup_quadrantmarkup_sharedtidbyt_canvasvestaboard_canvastransform_js

Markup content to write for the selected size.

contentstringrequired
The markup content to save.

3 status codes
200Returns a response containing the markup size and a boolean indicating whether the write succeeded.
dataobjectoptional
401Returned when the request is unauthorized.
errorstringoptional
422Returned when the specified markup size is invalid.

Error handling

A 401 is returned when the request is unauthorized. A 422 is returned when the size path parameter is not supported. The plugin_setting_id path parameter must identify a plugin setting you can access, and content is required.