Skip to main content
POST
/
v1
/
homes
/
{id}
/
update
curl -X 'POST' \
  'https://api.wattshift.com/v1/homes/ws_home_7bd6749d20f244d1bd3ba065dfd106c5/update' \
  -H 'accept: application/json' \
  -H 'x-ws-api-key: sk-b7991f7682a1579a7a3bb46abb7e43e8a21510b9b0b609418440462c40904c25' \
  -H 'Content-Type: application/json' \
  -d '{
  "utilityId" : "14328",
   "ratePlanId" : "690a0950c2008ed44bdef84d"
}'

{
  "id": "<string>",
  "createdAt": "<unknown>",
  "updatedAt": "<unknown>",
  "energyMarketBiddingEnabled": true,
  "carbonSignalIntensity": "LOW",
  "name": "<string>",
  "userId": "<string>",
  "UtilityId": "<string>",
  "ratePlanId": "<string>",
  "unstructuredAddress": "<string>",
  "timezone": "<string>",
  "country": "<string>",
  "city": "<string>",
  "zipcode": "<string>",
  "streetAddress": "<string>",
  "meterId": "<string>",
  "meterIdSource": "<string>",
  "enabled": true
}

​
Request

​
utilityId
string
The ID of the utility provider.
​
ratePlanId
string
The ID of the rate plan.
curl -X 'POST' \
  'https://api.wattshift.com/v1/homes/ws_home_7bd6749d20f244d1bd3ba065dfd106c5/update' \
  -H 'accept: application/json' \
  -H 'x-ws-api-key: sk-b7991f7682a1579a7a3bb46abb7e43e8a21510b9b0b609418440462c40904c25' \
  -H 'Content-Type: application/json' \
  -d '{
  "utilityId" : "14328",
   "ratePlanId" : "690a0950c2008ed44bdef84d"
}'

Headers

​
x-ws-api-key
string

WattShift API Key

Path Parameters

​
id
string
required

Body

application/json

The body is of type object.

Response

200 - application/json
​
id
string
required
​
createdAt
any
required
​
updatedAt
any
required
​
energyMarketBiddingEnabled
boolean
required
​
carbonSignalIntensity
enum<string>
required
Available options:
LOW,
MEDIUM,
HIGH
​
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