Skip to main content
POST
/
v1
/
onboarding
/
url
/
generate
generate onboarding url
curl --request POST \
  --url https://api.example.com/v1/onboarding/url/generate \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirectUrl": "<string>",
  "enableThirdPartyDevice": true,
  "hvacs": [
    {
      "name": "<string>",
      "enabled": true,
      "defaultMode": "OFF",
      "tempUnits": "F",
      "maxTemp": 123,
      "minTemp": 123,
      "defaultCoolSetpoint": 123,
      "defaultHeatSetpoint": 123,
      "deviceType": "Hvac",
      "canHeat": true,
      "canCool": true,
      "targetTemp": true,
      "targetCoolSetpoint": 123,
      "targetHeatSetpoint": 123,
      "currentTemp": 123,
      "referenceId": "<string>"
    }
  ],
  "userId": "<string>",
  "userEmail": "<string>",
  "homeId": "<string>"
}
'
{
  "url": "<string>",
  "homeId": "<string>"
}

Headers

x-ws-api-key
string

WattShift API Key

Body

application/json
redirectUrl
string
required
enableThirdPartyDevice
boolean
required
hvacs
object[]
required
userId
string
userEmail
string
homeId
string

used for resuming or restarting onboarding process for existing home

Response

200 - application/json
url
string
required

onboarding url

homeId
string
required

id of home being onboarded