Skip to main content
POST
/
v1
/
devices
/
hvac
/
{id}
/
preview
preview
curl --request POST \
  --url https://api.example.com/v1/devices/hvac/{id}/preview \
  --header 'Content-Type: application/json' \
  --header 'x-ws-api-key: <api-key>' \
  --data '
{
  "blocks": [],
  "defaultCoolSetpoint": 74,
  "defaultHeatSetpoint": 68,
  "defaultMaxTemp": 75,
  "defaultMinTemp": 65,
  "defaultMode": "AUTO",
  "tempUnits": "F"
}
'
{
  "setPointSchedule": {
    "blocks": [
      {
        "startDatetime": "2025-06-02T00:00:00.000Z",
        "endDatetime": "2025-06-02T08:00:00.000Z",
        "targetTemp": null,
        "targetCoolSetpoint": 74,
        "targetHeatSetpoint": 68,
        "targetMode": "AUTO"
      },
      {
        "startDatetime": "2025-06-02T08:00:00.000Z",
        "endDatetime": "2025-06-03T00:00:00.000Z",
        "targetTemp": null,
        "targetCoolSetpoint": 76,
        "targetHeatSetpoint": 66,
        "targetMode": "COOL"
      }
    ],
    "startDatetime": "2025-06-02T00:00:00.000Z",
    "endDatetime": "2025-06-03T00:00:00.000Z",
    "tempUnits": "F"
  },
  "temperatureData": [
    68,
    69,
    70,
    71
  ],
  "rates": [
    0.24,
    0.26,
    0.28,
    0.3
  ],
  "estimatedSavings": 12.45
}

Authorizations

x-ws-api-key
string
header
required

Headers

x-ws-api-key
string

WattShift API Key

Path Parameters

id
string
required

Body

application/json

Preview an HVAC schedule. defaultCoolSetpoint and defaultHeatSetpoint are required when blocks is empty.

blocks
object[]

Array of schedule blocks

defaultCoolSetpoint
number

The default cool setpoint for the HVAC unit. Required when blocks is empty.

defaultHeatSetpoint
number

The default heat setpoint for the HVAC unit. Required when blocks is empty.

defaultMaxTemp
number

The max default temperature

defaultMinTemp
number

The min default temperature

includeEstimatedSavings
boolean

Set true to include estimated savings

Response

200 - application/json
setPointSchedule
object
required
temperatureData
number[]
required
rates
number[]
required
estimatedSavings
number