Skip to main content
POST
get user preference

Authorizations

x-ws-api-key
string
header
required

WattShift API key

Headers

x-ws-api-key
string

WattShift API Key

Path Parameters

id
string
required

Response

200 - application/json
name
string
required

The human-readable name for the schedule

Minimum string length: 1
scheduleBlocks
object[]
required

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

enabled
boolean
required

Whether this schedule should be enabled

tempUnits
enum<string>
required

The units for temperature.

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

Required range: 0 < x < 52
defaultMode
enum<string>
default:AUTO

The default mode for the HVAC unit.

Available options:
OFF,
HEAT,
COOL,
AUTO
defaultTemp
number
Required range: -50 < x < 200
currentTemp
number

The current temperature

Required range: -50 < x < 200
targetTemp
number

The target temperature

Required range: -50 < x < 200
targetCoolSetpoint
number

The target cool setpoint

Required range: -50 < x < 200
targetHeatSetpoint
number

The target heat setpoint

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