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
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

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.

enabled
boolean
required

Whether this schedule should be enabled

defaultMode
enum<string>
default: AUTOrequired

The default mode for the HVAC unit.

Available options:
OFF,
HEAT,
COOL,
AUTO
tempUnits
enum<string>
required

The units for temperature.

Available options:
F,
C
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

maxTemp
number
required

The max default temperature

minTemp
number
required

The min default temperature

Response

200 - application/json
blocks
object[]
required
startDatetime
any
required

ISO 8601 date time string

endDatetime
any
required

ISO 8601 date time string

tempUnits
enum<string>
required
Available options:
F,
C
record thermostat behaviorget user preference