Content & ServicesDeveloper Platform
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
Device alias. Send null or an empty string to clear it. Maximum 100 characters.
Device location. Send null or an empty string to clear it. Maximum 100 characters.
Device timezone. Must be a key returned by the List Timezones API.
Refresh interval settings.
Parameters
Refresh interval while connected to power, in milliseconds. Must be 60,000-86,400,000 and a multiple of 60,000.
Refresh interval while using battery power, in milliseconds. Must be 900,000-43,200,000 and a multiple of 60,000.
Sleep settings. start/end use local HH:mm time in the device timezone. If end is earlier than start, it means the next day.
Parameters
Whether sleep is enabled.
Sleep start time in 24-hour HH:mm format.
Sleep end time in 24-hour HH:mm format. Cannot be the same as start.
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