POST
/
v1
/
devices
/
hvac
/
{id}
/
user_preferences
/
get

Headers

​
x-ws-api-key
string

WattShift API Key

Path Parameters

​
id
string
required

Response

200 - application/json
​
defaultMode
enum<string>
default:
AUTO
required

The default mode for the HVAC unit.

Available options:
OFF,
HEAT,
COOL,
AUTO
​
defaultTemp
number
required

The default temperature for the hvac unit. This must be set unless the default mode is OFF or there are schedule blocks added

​
enabled
boolean
required

Whether this schedule should be enabled

​
maxTemp
number
required

The max default temperature

​
minTemp
number
required

The min default temperature

​
name
string
required

The human-readable name for the schedule

​
scheduleBlocks
object[]
required

0 or more blocks for this schedule to follow. If no blocks are added, the default temp will be followed

​
tempUnits
enum<string>
required

The units for temperature.

Available options:
F,
C
​
weekNumbers
number[]
required

The week numbers to apply this schedule. For example, [0,1,2,...,51] applies to all 52 weeks of the year. Leave empty to also apply to all weeks.

set user preferencepreview