Skip to main content
POST
/
v1
/
homes
/
{id}
/
update
update home
curl --request POST \
  --url https://api.example.com/v1/homes/{id}/update \
  --header 'Content-Type: application/json' \
  --header 'x-ws-api-key: <api-key>' \
  --data '{}'
{
  "id": "<string>",
  "createdAt": "<unknown>",
  "updatedAt": "<unknown>",
  "energyMarketBiddingEnabled": true,
  "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,
  "channelPartnerId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.wattshift.com/llms.txt

Use this file to discover all available pages before exploring further.

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

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
​
channelPartnerId
string | null