Skip to main content
POST
generate onboarding url

Authorizations

x-ws-api-key
string
header
required

WattShift API key

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