remove home
curl --request POST \
--url https://api.example.com/v1/homes/{id}/remove \
--header 'x-ws-api-key: <api-key>'import requests
url = "https://api.example.com/v1/homes/{id}/remove"
headers = {"x-ws-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-ws-api-key': '<api-key>'}};
fetch('https://api.example.com/v1/homes/{id}/remove', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/homes/{id}/remove",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-ws-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/homes/{id}/remove"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-ws-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/homes/{id}/remove")
.header("x-ws-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/homes/{id}/remove")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-ws-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "ws_home_123456789",
"createdAt": "2025-01-02T12:00:00.000Z",
"updatedAt": "2025-01-02T12:00:00.000Z",
"name": "My home",
"userId": "user_123456789",
"UtilityId": "12199",
"ratePlanId": "6915de25881cbc6041e4c7f1",
"unstructuredAddress": null,
"timezone": "America/Los_Angeles",
"country": "US",
"city": "San Francisco",
"zipcode": "94107",
"streetAddress": "123 Market St",
"meterId": null,
"meterIdSource": null,
"energyMarketBiddingEnabled": true,
"enabled": true,
"carbonSignalIntensity": "MEDIUM",
"channelPartnerId": null
}{
"request_id": "req_123",
"error_code": "VALIDATION_FAILED",
"message": "Request validation failed.",
"field_errors": [
{
"field": "zipcode",
"message": "zipcode is invalid"
}
]
}{
"request_id": "req_123",
"error_code": "AUTH_MISSING_API_KEY",
"message": "Missing x-ws-api-key header.",
"recovery_action": "Provide the x-ws-api-key header. If this contradicts the public docs or OpenAPI contract, submit structured feedback through /v1/feedback."
}homes
remove home
Removes a sandbox/test home owned by the API credential. Uses the same homes:write scope as createHome.
POST
/
v1
/
homes
/
{id}
/
remove
remove home
curl --request POST \
--url https://api.example.com/v1/homes/{id}/remove \
--header 'x-ws-api-key: <api-key>'import requests
url = "https://api.example.com/v1/homes/{id}/remove"
headers = {"x-ws-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-ws-api-key': '<api-key>'}};
fetch('https://api.example.com/v1/homes/{id}/remove', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/homes/{id}/remove",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-ws-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/homes/{id}/remove"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-ws-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/homes/{id}/remove")
.header("x-ws-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/homes/{id}/remove")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-ws-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "ws_home_123456789",
"createdAt": "2025-01-02T12:00:00.000Z",
"updatedAt": "2025-01-02T12:00:00.000Z",
"name": "My home",
"userId": "user_123456789",
"UtilityId": "12199",
"ratePlanId": "6915de25881cbc6041e4c7f1",
"unstructuredAddress": null,
"timezone": "America/Los_Angeles",
"country": "US",
"city": "San Francisco",
"zipcode": "94107",
"streetAddress": "123 Market St",
"meterId": null,
"meterIdSource": null,
"energyMarketBiddingEnabled": true,
"enabled": true,
"carbonSignalIntensity": "MEDIUM",
"channelPartnerId": null
}{
"request_id": "req_123",
"error_code": "VALIDATION_FAILED",
"message": "Request validation failed.",
"field_errors": [
{
"field": "zipcode",
"message": "zipcode is invalid"
}
]
}{
"request_id": "req_123",
"error_code": "AUTH_MISSING_API_KEY",
"message": "Missing x-ws-api-key header.",
"recovery_action": "Provide the x-ws-api-key header. If this contradicts the public docs or OpenAPI contract, submit structured feedback through /v1/feedback."
}Authorizations
x-ws-api-keyx-ws-api-key
WattShift API key
Headers
WattShift API Key
Path Parameters
Response
Available options:
LOW, MEDIUM, HIGH ⌘I
