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

Headers

x-ws-api-key
string

WattShift API Key

Path Parameters

id
string
required

Body

application/json
defaultMode
enum<string>
required

The default mode for the HVAC unit.

Available options:
OFF,
HEAT,
COOL,
AUTO
enabled
boolean
required

Whether this schedule should be enabled

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
currentTemp
number
Required range: -50 <= x <= 200
defaultCoolSetpoint
number

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

Required range: -50 <= x <= 200
defaultHeatSetpoint
number

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

Required range: -50 <= x <= 200
maxTemp
number

The max default temperature

Required range: -50 <= x <= 200
minTemp
number

The min default temperature

Required range: -50 <= x <= 200
targetCoolSetpoint
number
Required range: -50 <= x <= 200
targetHeatSetpoint
number
Required range: -50 <= x <= 200
weekNumbers
integer[]

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.