POST
/
v1
/
homes
/
{id}
/
update
{
  "id": "<string>",
  "createdAt": "<any>",
  "updatedAt": "<any>",
  "name": "<string>",
  "userId": "<string>",
  "UtilityId": "<string>",
  "ratePlanId": "<string>",
  "unstructuredAddress": "<string>",
  "timezone": "<string>",
  "country": "<string>",
  "city": "<string>",
  "zipcode": "<string>",
  "streetAddress": "<string>",
  "meterId": "<string>",
  "meterIdSource": "<string>",
  "energyMarketBiddingEnabled": true,
  "enabled": true
}

Headers

​
x-ws-api-key
string

WattShift API Key

Path Parameters

​
id
string
required

Body

application/json
​
userId
string

The ID of the owner of the home

Example:

"ckkz9q3qo0000yj6j5q9q9q9q"

​
name
string

The name of the home

Example:

"My Home"

​
UtilityId
string
​
utilityId
string
​
ratePlanId
string
​
unstructuredAddress
string
​
clientId
string
​
country
string
​
city
string
​
zipcode
string
​
streetAddress
string
​
solarInfo
object
​
enabled
boolean

this is to check is enabled

Response

200 - application/json
​
id
string
required
​
createdAt
any
required
​
updatedAt
any
required
​
energyMarketBiddingEnabled
boolean
required
​
name
string | null
​
userId
string | null
​
UtilityId
string | null
​
ratePlanId
string | null
​
unstructuredAddress
string | null
​
timezone
string | null
​
country
string | null
​
city
string | null
​
zipcode
string | null
​
streetAddress
string | null
​
meterId
string | null
​
meterIdSource
string | null
​
enabled
boolean | null
get price signal open adrfind HVAC