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

Update a user theme

Updates a user theme's name and/or settings. Use settings to override framework defaults; omitted keys retain their defaults, and keys the recipe does not read are ignored rather than rejected.

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

1 parameter · 2 body fields
idintegerrequired
The numeric identifier of the theme to update.

Theme update fields. Supply name, settings, or both.

namestringoptional
The theme's name.
settingsobjectoptional
Every key is optional; an omitted key keeps the framework default. A value outside the vocabulary (an unrecognized token, surface, hue, or advanced channel) answers 422; a key the recipe does not read is ignored, not rejected.

4 status codes
200Returns the updated theme in a `data` object containing its identifier, name, settings, SCSS, and creation and update timestamps.
dataobjectoptional
401Returned when the request is unauthenticated.
errorstringoptional
404Returned when the theme belongs to another user.
422Returned when settings contain values outside the recipe vocabulary.

Error handling

A 401 is returned when the request is unauthenticated. A 404 is returned when the theme belongs to another user; the id path parameter must identify a theme the authenticated user can update. A 422 is returned when settings contains a value outside the recipe vocabulary.