Update Device Settings
Update the settings of the device.
The body is a partial update: only the fields it names are changed, the
rest keep their current value. false and "" are values like any
other, so {"wifi_enabled": false} turns WiFi off, while a body that
omits wifi_enabled leaves it as it is. An unrecognised field is
rejected with 400 rather than ignored, so a typo cannot silently read
as “leave this one alone”. null means the same as omitting the field —
to clear a string, send "".
Authorizations
Short-lived session token obtained from POST /api/sessions/v2.
Send it as Authorization: Bearer <session_token> together with the X-Device-Key: <device-key> header identifying the target device.
Headers
Device Key (4 BIP39 words) identifying the target device.
Obtain it from POST /device/otp/confirm/v2.
^[a-z]+-[a-z]+-[a-z]+-[a-z]+$"orbit-ranch-silver-tomato"
Body
Device settings. Every field is optional in both directions: a request carries only the
fields it wants to change, and a response omits a field the device does not report. An
explicit false is a value, not an omission, so sending wifi_enabled: false or
ble_enabled: false can drop the connection you are using. An unknown field name is
rejected with 400.
The name of the device.
"My Awesome Device"
Enable/disable WiFi on device.
true
Enable/disable BLE on device.
true
When enabled, the device powers on after a 3-second hold of the mode button; when disabled, after 500 ms.
true
String shown after "Hello!" label on intro screen.
"Welcome!"
Client name set by the client after connection. The device stores up to 32 characters; a name written over BLE is capped at 31.
"My App"
Response
Updated Device Settings
Device settings. Every field is optional in both directions: a request carries only the
fields it wants to change, and a response omits a field the device does not report. An
explicit false is a value, not an omission, so sending wifi_enabled: false or
ble_enabled: false can drop the connection you are using. An unknown field name is
rejected with 400.
The name of the device.
"My Awesome Device"
Enable/disable WiFi on device.
true
Enable/disable BLE on device.
true
When enabled, the device powers on after a 3-second hold of the mode button; when disabled, after 500 ms.
true
String shown after "Hello!" label on intro screen.
"Welcome!"
Client name set by the client after connection. The device stores up to 32 characters; a name written over BLE is capped at 31.
"My App"