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

Update a device

Updates settings on a device. Supply only the settings you want to change; settings the device cannot use are dropped. For native devices, you can switch only between OG models.

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

1 parameter · 39 body fields
idintegerrequired
The unique identifier of the device to update.

Device settings to update. Settings the device cannot use are dropped.

auto_advancebooleanoptional
Beta: may change or go away. false keeps the current screen until a button press; taken only when management.writable_fields lists it
custom_formatstringoptional
byod_custom model only
custom_heightintegeroptional
byod_custom model only
custom_widthintegeroptional
byod_custom model only
dither_pixel_rationumberoptional
byod_custom model only
firmware_channelstringoptional
Firmware channel: development, test, staging, or production.
Allowed:developmentteststagingproduction
font_familystringoptional
Font family to use on the device.
framework_sizestringoptional
byod_custom model only
Allowed:smmdlg
guest_mode_item_durationintegeroptional
Duration for a guest-mode playlist item.
guest_mode_item_idintegeroptional
ID of the playlist item used in guest mode.
low_battery_notification_emailstringoptional
Email address for low-battery notifications.
low_battery_notification_enabledbooleanoptional
Whether low-battery notifications are enabled.
low_battery_screen_disabledbooleanoptional
Whether the low-battery screen is disabled.
maximum_compatibilitybooleanoptional
Whether maximum compatibility is enabled.
maximum_image_bytesintegeroptional
byod_custom model only
model_idintegeroptional
listModels; a BYOD device can take any model
namestringoptional
orientationintegeroptional
ota_enabledbooleanoptional
palette_idstringoptional
listPalettes
percent_chargednumberoptional
playlist_item_ttlintegeroptional
Hours a playlist item can go without a new screen before it is skipped; null never skips
Allowed:24487296120144168
refresh_intervalintegeroptional
Seconds between check-ins, 300 to 86400
refreshing_screen_disabledbooleanoptional
rotateintegeroptional
scale_factornumberoptional
BYOD only
sleep_end_timeintegeroptional
Minutes after midnight, 0 to 1439
sleep_mode_enabledbooleanoptional
sleep_screen_enabledbooleanoptional
sleep_start_timeintegeroptional
Minutes after midnight, 0 to 1439
sleep_untilstringoptional
Sleep once, from the next check-in until this ISO 8601 time (at most a year out); no offset means the account time zone, null cancels. Any later check-in, such as a button press, wakes the device
special_functionstringoptional
temperature_profilestringoptional
Allowed:defaultab
text_scalestringoptional
Allowed:smallregularlargexlarge
themestringoptional
touchbar_modestringoptional
Allowed:tapswipe
ui_scalenumberoptional
BYOD only
visibilitystringoptional
Allowed:standalonesharable
waits_for_next_renderbooleanoptional

4 status codes
200Returns the updated device data, including its current settings and device details.
dataobjectoptional
401Returned when the request is unauthorized.
errorstringoptional
422Returned when the submitted settings cannot be processed.
errorstringoptional
429Returned when an appearance change would render every playlist item again and exceed the hourly render allowance.
errorstringoptional

Error handling

A 401 is returned when the request is unauthorized. The id path parameter identifies the device to update. A 422 is returned when the submitted settings cannot be processed; firmware_channel must be one of development, test, staging, or production. An appearance change that renders every playlist item beyond the hourly allowance returns a 429.