Content & ServicesOpen PlatformNew
Device Settings
Quick Guide
Use the Device Settings API to read or update settings for a device owned by the authenticated API key user. Writes use POST; omitted fields stay unchanged.
Read Settings
GET
/api/authV2/open/device/:deviceId/settingsGenerated Code
1// Generating...Update Settings
POST
/api/authV2/open/device/:deviceId/settingsGenerated Code
1// Generating...Request Fields
Prop
Type
Name shown in the device list, up to 100 characters. Omit to keep the current name; explicitly send an empty value to clear it.
Label for where the device is placed, up to 100 characters. Omit to keep the current label; explicitly send an empty value to clear it.
Local timezone used for schedules. Choose an identifier returned by the List Timezones API.
How often the device refreshes content or wakes to check for updates.
Parameters
Automatic content switching interval on external power, in whole-minute multiples of 60,000 milliseconds. The minimum depends on the model; see the table below.
Automatic wake and content switching interval on battery power, in whole-minute multiples of 60,000 milliseconds. The minimum depends on the model; see the table below.
Daily sleep window in the device timezone. An end time earlier than the start time falls on the following day.
Parameters
Enables or disables the daily sleep window.
Time the device enters sleep, in local 24-hour HH:mm format.
Time the device wakes, in local 24-hour HH:mm format. Must differ from the sleep start time.
Automatic switching intervals
| Device | External power | Battery power |
|---|---|---|
| Quote/0, Quote/1 | 1 minute–12 hours | 1 minute–12 hours |
| Rand/0 | 15 minutes–12 hours | 1 hour–12 hours |
| ZenMeasure M401 | 1 minute–12 hours | 30 minutes–12 hours |
These ranges apply to automatic switching. Manual refresh is not limited by this interval. Settings requests outside the range are rejected.
Timezones
The timezone field only accepts keys returned by the Get Timezones API. See the Get Timezones page for the current server-supported timezone list.
Did this solve your problem?
Join our community