Update shower

curl --request PUT \
  --url https://api.orbital-systems.com/client/showers/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Bathroom",
  "device_group": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
  "owner": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
  "installation_info": {
    "installation_name": "installer@example.com",
    "installation_date": "2026-03-14T10:02:00.000Z"
  },
  "installation_test": {
    "id": "9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d"
  },
  "state": "active",
  "updated_at": "2026-10-28T17:03:10.000Z",
  "control_dial_notifications": true
}
'

import requests

url = "https://api.orbital-systems.com/client/showers/{id}"

payload = {
    "name": "Bathroom",
    "device_group": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
    "owner": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
    "installation_info": {
        "installation_name": "installer@example.com",
        "installation_date": "2026-03-14T10:02:00.000Z"
    },
    "installation_test": { "id": "9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d" },
    "state": "active",
    "updated_at": "2026-10-28T17:03:10.000Z",
    "control_dial_notifications": True
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Bathroom',
    device_group: '6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b',
    owner: '6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b',
    installation_info: {
      installation_name: 'installer@example.com',
      installation_date: '2026-03-14T10:02:00.000Z'
    },
    installation_test: {id: '9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d'},
    state: 'active',
    updated_at: '2026-10-28T17:03:10.000Z',
    control_dial_notifications: true
  })
};

fetch('https://api.orbital-systems.com/client/showers/{id}', 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.orbital-systems.com/client/showers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Bathroom',
    'device_group' => '6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b',
    'owner' => '6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b',
    'installation_info' => [
        'installation_name' => 'installer@example.com',
        'installation_date' => '2026-03-14T10:02:00.000Z'
    ],
    'installation_test' => [
        'id' => '9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d'
    ],
    'state' => 'active',
    'updated_at' => '2026-10-28T17:03:10.000Z',
    'control_dial_notifications' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orbital-systems.com/client/showers/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Bathroom\",\n  \"device_group\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\",\n  \"owner\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\",\n  \"installation_info\": {\n    \"installation_name\": \"installer@example.com\",\n    \"installation_date\": \"2026-03-14T10:02:00.000Z\"\n  },\n  \"installation_test\": {\n    \"id\": \"9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d\"\n  },\n  \"state\": \"active\",\n  \"updated_at\": \"2026-10-28T17:03:10.000Z\",\n  \"control_dial_notifications\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.orbital-systems.com/client/showers/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Bathroom\",\n  \"device_group\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\",\n  \"owner\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\",\n  \"installation_info\": {\n    \"installation_name\": \"installer@example.com\",\n    \"installation_date\": \"2026-03-14T10:02:00.000Z\"\n  },\n  \"installation_test\": {\n    \"id\": \"9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d\"\n  },\n  \"state\": \"active\",\n  \"updated_at\": \"2026-10-28T17:03:10.000Z\",\n  \"control_dial_notifications\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbital-systems.com/client/showers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Bathroom\",\n  \"device_group\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\",\n  \"owner\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\",\n  \"installation_info\": {\n    \"installation_name\": \"installer@example.com\",\n    \"installation_date\": \"2026-03-14T10:02:00.000Z\"\n  },\n  \"installation_test\": {\n    \"id\": \"9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d\"\n  },\n  \"state\": \"active\",\n  \"updated_at\": \"2026-10-28T17:03:10.000Z\",\n  \"control_dial_notifications\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "0b7a6c1e-5f2d-4c3b-8a9e-1d2f3a4b5c6d",
  "owner": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
  "name": "Bathroom",
  "state": "active",
  "saved_water": 18250.4,
  "saved_energy": 742.18,
  "sessions": 512,
  "latest_session": "2026-11-02T06:20:00.000Z",
  "filter_status": 72,
  "device_group": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
  "last_connected": "2026-11-02T06:40:12.000Z",
  "last_disconnected": "2026-11-01T23:10:05.000Z",
  "created_at": "2026-03-14T09:12:44.000Z",
  "build_id": "v3.17.8",
  "replace_uv": false,
  "is_cleaning_program_required": false,
  "clean_sensor_tank": false,
  "no_recirculation": false,
  "float_leak": false,
  "operating": {
    "cleaning_programs": 12,
    "inner_heat_treatments": 498,
    "outer_heat_treatments": 64,
    "sessions": 1203,
    "sessions_since_cleaning_program": 8,
    "sessions_since_inner_heat_treatment": 1,
    "sessions_since_outer_heat_treatment": 5,
    "liters_since_last_descaling": 640
  },
  "oas_revision": 3,
  "serial_number": "2214-0005",
  "wifi_ssid": "HomeNetwork",
  "installation_info": {
    "installation_name": "installer@example.com",
    "installation_date": "2026-03-14T10:02:00.000Z"
  },
  "installation_test": {
    "id": "9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d"
  },
  "type": "shower",
  "base": 19,
  "control_dial_notifications": true,
  "control_dial_ui": "swipe",
  "hibernating": false,
  "updated_at": "2026-10-28T17:03:10.000Z",
  "descaling_status": 64,
  "role": "owner"
}

{
  "message": "Unauthorized",
  "statusCode": 401,
  "name": "UnauthorizedError"
}

{
  "message": "Shower not found",
  "statusCode": 404,
  "name": "NotFoundError"
}

{
  "message": "Shower name already exists",
  "statusCode": 409,
  "name": "ConflictError"
}

{
  "message": "Internal server error"
}

PUT

client

showers

{id}

Update shower

curl --request PUT \
  --url https://api.orbital-systems.com/client/showers/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Bathroom",
  "device_group": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
  "owner": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
  "installation_info": {
    "installation_name": "installer@example.com",
    "installation_date": "2026-03-14T10:02:00.000Z"
  },
  "installation_test": {
    "id": "9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d"
  },
  "state": "active",
  "updated_at": "2026-10-28T17:03:10.000Z",
  "control_dial_notifications": true
}
'

import requests

url = "https://api.orbital-systems.com/client/showers/{id}"

payload = {
    "name": "Bathroom",
    "device_group": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
    "owner": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
    "installation_info": {
        "installation_name": "installer@example.com",
        "installation_date": "2026-03-14T10:02:00.000Z"
    },
    "installation_test": { "id": "9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d" },
    "state": "active",
    "updated_at": "2026-10-28T17:03:10.000Z",
    "control_dial_notifications": True
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Bathroom',
    device_group: '6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b',
    owner: '6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b',
    installation_info: {
      installation_name: 'installer@example.com',
      installation_date: '2026-03-14T10:02:00.000Z'
    },
    installation_test: {id: '9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d'},
    state: 'active',
    updated_at: '2026-10-28T17:03:10.000Z',
    control_dial_notifications: true
  })
};

fetch('https://api.orbital-systems.com/client/showers/{id}', 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.orbital-systems.com/client/showers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Bathroom',
    'device_group' => '6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b',
    'owner' => '6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b',
    'installation_info' => [
        'installation_name' => 'installer@example.com',
        'installation_date' => '2026-03-14T10:02:00.000Z'
    ],
    'installation_test' => [
        'id' => '9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d'
    ],
    'state' => 'active',
    'updated_at' => '2026-10-28T17:03:10.000Z',
    'control_dial_notifications' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orbital-systems.com/client/showers/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Bathroom\",\n  \"device_group\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\",\n  \"owner\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\",\n  \"installation_info\": {\n    \"installation_name\": \"installer@example.com\",\n    \"installation_date\": \"2026-03-14T10:02:00.000Z\"\n  },\n  \"installation_test\": {\n    \"id\": \"9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d\"\n  },\n  \"state\": \"active\",\n  \"updated_at\": \"2026-10-28T17:03:10.000Z\",\n  \"control_dial_notifications\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.orbital-systems.com/client/showers/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Bathroom\",\n  \"device_group\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\",\n  \"owner\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\",\n  \"installation_info\": {\n    \"installation_name\": \"installer@example.com\",\n    \"installation_date\": \"2026-03-14T10:02:00.000Z\"\n  },\n  \"installation_test\": {\n    \"id\": \"9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d\"\n  },\n  \"state\": \"active\",\n  \"updated_at\": \"2026-10-28T17:03:10.000Z\",\n  \"control_dial_notifications\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbital-systems.com/client/showers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Bathroom\",\n  \"device_group\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\",\n  \"owner\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\",\n  \"installation_info\": {\n    \"installation_name\": \"installer@example.com\",\n    \"installation_date\": \"2026-03-14T10:02:00.000Z\"\n  },\n  \"installation_test\": {\n    \"id\": \"9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d\"\n  },\n  \"state\": \"active\",\n  \"updated_at\": \"2026-10-28T17:03:10.000Z\",\n  \"control_dial_notifications\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "0b7a6c1e-5f2d-4c3b-8a9e-1d2f3a4b5c6d",
  "owner": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
  "name": "Bathroom",
  "state": "active",
  "saved_water": 18250.4,
  "saved_energy": 742.18,
  "sessions": 512,
  "latest_session": "2026-11-02T06:20:00.000Z",
  "filter_status": 72,
  "device_group": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
  "last_connected": "2026-11-02T06:40:12.000Z",
  "last_disconnected": "2026-11-01T23:10:05.000Z",
  "created_at": "2026-03-14T09:12:44.000Z",
  "build_id": "v3.17.8",
  "replace_uv": false,
  "is_cleaning_program_required": false,
  "clean_sensor_tank": false,
  "no_recirculation": false,
  "float_leak": false,
  "operating": {
    "cleaning_programs": 12,
    "inner_heat_treatments": 498,
    "outer_heat_treatments": 64,
    "sessions": 1203,
    "sessions_since_cleaning_program": 8,
    "sessions_since_inner_heat_treatment": 1,
    "sessions_since_outer_heat_treatment": 5,
    "liters_since_last_descaling": 640
  },
  "oas_revision": 3,
  "serial_number": "2214-0005",
  "wifi_ssid": "HomeNetwork",
  "installation_info": {
    "installation_name": "installer@example.com",
    "installation_date": "2026-03-14T10:02:00.000Z"
  },
  "installation_test": {
    "id": "9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d"
  },
  "type": "shower",
  "base": 19,
  "control_dial_notifications": true,
  "control_dial_ui": "swipe",
  "hibernating": false,
  "updated_at": "2026-10-28T17:03:10.000Z",
  "descaling_status": 64,
  "role": "owner"
}

{
  "message": "Unauthorized",
  "statusCode": 401,
  "name": "UnauthorizedError"
}

{
  "message": "Shower not found",
  "statusCode": 404,
  "name": "NotFoundError"
}

{
  "message": "Shower name already exists",
  "statusCode": 409,
  "name": "ConflictError"
}

{
  "message": "Internal server error"
}

Authorizations

x-api-key

string

header

required

Send your API key in the x-api-key header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets 403 with { "message": "Forbidden" }.

Path Parameters

string

required

The unique identifier for the shower

Body

application/json

name

string

Display name of the shower. Must differ from the names of your other showers.

Example:

"Bathroom"

device_group

string | null

ID of the group the device belongs to. Pairing sets it to your user ID.

Example:

"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b"

owner

string | null

User ID of the owner. null when the device isn’t paired.

Example:

"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b"

installation_info

object | null

Who started the installation test and when. null once the test is cancelled.

Show child attributes

installation_test

object | null

The latest installation test. null once it is cancelled.

Show child attributes

state

enum<string>

Lifecycle state. A device is pending until it is first paired, then active. Lists only include pending and active devices.

Available options:

pending,

active,

archived,

service,

replaced

Example:

"active"

updated_at

string

When the change was made (ISO 8601). Defaults to the current time.

Example:

"2026-10-28T17:03:10.000Z"

control_dial_notifications

boolean

Shows maintenance reminders (filter, UV lamp, descaling, sensor tank) on the Control dial.

Example:

true

Response

Shower updated successfully

string<uuid>

Unique ID of the device (UUID).

Example:

"0b7a6c1e-5f2d-4c3b-8a9e-1d2f3a4b5c6d"

owner

string | null

User ID of the owner. null when the device isn’t paired.

Example:

"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b"

name

string

Display name of the device.

Example:

"Bathroom"

state

enum<string>

Lifecycle state. A device is pending until it is first paired, then active. Lists only include pending and active devices.

Available options:

pending,

active,

archived,

service,

replaced

Example:

"active"

saved_water

number

Water saved by the shower so far, in litres.

Example:

18250.4

saved_energy

number

Energy saved by the shower so far, in kWh.

Example:

742.18

sessions

number

Number of shower sessions so far.

Example:

512

latest_session

string

When the latest session of any kind started, cleaning included (ISO 8601).

Example:

"2026-11-02T06:20:00.000Z"

filter_status

number

Filter life left, in percent (0–100).

Example:

72

device_group

string | null

ID of the group the device belongs to. Pairing sets it to your user ID.

Example:

"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b"

last_connected

string

When the device last connected (ISO 8601).

Example:

"2026-11-02T06:40:12.000Z"

last_disconnected

string

When the device last disconnected (ISO 8601). The device is offline when this is later than last_connected.

Example:

"2026-11-01T23:10:05.000Z"

created_at

string

When the record was created (ISO 8601).

Example:

"2026-03-14T09:12:44.000Z"

build_id

string

Firmware build running on the shower.

Example:

"v3.17.8"

replace_uv

boolean

The UV lamp should be replaced.

Example:

false

is_cleaning_program_required

boolean

The shower needs descaling.

Example:

false

clean_sensor_tank

boolean

The sensor tank should be cleaned.

Example:

false

no_recirculation

boolean

The latest shower session saved no water although a recirculating mode was on.

Example:

false

float_leak

boolean

The shower has detected a leak.

Example:

false

operating

object

Counters reported by the shower.

Show child attributes

oas_revision

any

Hardware revision of the shower.

Example:

3

serial_number

string

Serial number of the shower.

Example:

"2214-0005"

wifi_ssid

string

Name of the Wi-Fi network the shower is on.

Example:

"HomeNetwork"

installation_info

object | null

Who started the installation test and when. null once the test is cancelled.

Show child attributes

installation_test

object | null

The latest installation test. null once it is cancelled.

Show child attributes

type

enum<string>

Always shower.

Available options:

shower

Example:

"shower"

base

number

Software base version of the shower.

Example:

19

control_dial_notifications

boolean

Shows maintenance reminders (filter, UV lamp, descaling, sensor tank) on the Control dial.

Example:

true

control_dial_ui

enum<string> | null

Interface on the Control dial: classic or swipe. null until the shower reports it.

Available options:

classic,

swipe

Example:

"swipe"

hibernating

boolean

The shower is hibernating.

Example:

false

updated_at

string

When the record was last changed (ISO 8601).

Example:

"2026-10-28T17:03:10.000Z"

descaling_status

number

How far the shower is from needing descaling, in percent: 100 just descaled, 0 descaling due.

Example:

64

role

enum<string>

Your access to the device: owner (you paired it) or, for a device shared with you, user or maintenance. maintenance can read the device but not change it, control it or see its sessions. Only included by GET /client/showers and GET /client/showers/{id}.

Available options:

owner,

maintenance,

user

Example:

"owner"

Groups.

History.

History metadata.

User invites.

Showers.

Shower pairing.

Shower savings.

Shower commissioning.

Shower configuration.

Shower instant start schedules.

Shower installation.

Shower commands.

Taps.

Tap pairing.

Tap configuration.

Tap commands.

User.

Update shower

Authorizations

Path Parameters

Body

Response