Skip to main content
POST
Update Device Settings

Authorizations

Authorization
string
header
required

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

X-Device-Key
string
required

Device Key (4 BIP39 words) identifying the target device. Obtain it from POST /device/otp/confirm/v2.

Pattern: ^[a-z]+-[a-z]+-[a-z]+-[a-z]+$
Example:

"alpha-bravo-charlie-delta"

Body

application/json
device_name
string
required

The name of the device.

Example:

"My Awesome Device"

wifi_enabled
boolean
required

Enable/disable WiFi on device.

Example:

true

ble_enabled
boolean
required

Enable/disable BLE on device.

Example:

true

travel_mode
boolean
required

If enabled device is powered on after 3 seconds mode button hold. If disabled - after 500 ms.

Example:

true

intro_label
string
required

String shown after "Hello!" label on intro screen.

Example:

"Welcome!"

client_name
string

Client name that is set by the client after connection (max 64 chars).

Example:

"My App"

Response

200 - application/json

Updated Device Settings

device_name
string
required

The name of the device.

Example:

"My Awesome Device"

wifi_enabled
boolean
required

Enable/disable WiFi on device.

Example:

true

ble_enabled
boolean
required

Enable/disable BLE on device.

Example:

true

travel_mode
boolean
required

If enabled device is powered on after 3 seconds mode button hold. If disabled - after 500 ms.

Example:

true

intro_label
string
required

String shown after "Hello!" label on intro screen.

Example:

"Welcome!"

client_name
string

Client name that is set by the client after connection (max 64 chars).

Example:

"My App"