Update group
curl --request PUT \
--url https://api.orbital-systems.com/client/groups/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Gym, floor 2",
"type": "child",
"parent_id": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b"
}
'import requests
url = "https://api.orbital-systems.com/client/groups/{id}"
payload = {
"name": "Gym, floor 2",
"type": "child",
"parent_id": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b"
}
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: 'Gym, floor 2',
type: 'child',
parent_id: '6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b'
})
};
fetch('https://api.orbital-systems.com/client/groups/{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/groups/{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' => 'Gym, floor 2',
'type' => 'child',
'parent_id' => '6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b'
]),
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/groups/{id}"
payload := strings.NewReader("{\n \"name\": \"Gym, floor 2\",\n \"type\": \"child\",\n \"parent_id\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\"\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/groups/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Gym, floor 2\",\n \"type\": \"child\",\n \"parent_id\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbital-systems.com/client/groups/{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\": \"Gym, floor 2\",\n \"type\": \"child\",\n \"parent_id\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\"\n}"
response = http.request(request)
puts response.read_body{
"id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"name": "Gym, floor 2",
"type": "child",
"parent_id": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
"created_at": "2026-03-14T09:12:44.000Z",
"updated_at": "2026-10-28T17:03:10.000Z"
}{
"message": "Invalid Group",
"statusCode": 400,
"name": "InvalidParameterError"
}{
"message": "Unauthorized.",
"statusCode": 401,
"name": "UnauthorizedError"
}{
"message": "Group not found.",
"statusCode": 404,
"name": "NotFoundError"
}{
"message": "Internal server error"
}Groups.
Update group
PUT
/
client
/
groups
/
{id}
Update group
curl --request PUT \
--url https://api.orbital-systems.com/client/groups/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Gym, floor 2",
"type": "child",
"parent_id": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b"
}
'import requests
url = "https://api.orbital-systems.com/client/groups/{id}"
payload = {
"name": "Gym, floor 2",
"type": "child",
"parent_id": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b"
}
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: 'Gym, floor 2',
type: 'child',
parent_id: '6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b'
})
};
fetch('https://api.orbital-systems.com/client/groups/{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/groups/{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' => 'Gym, floor 2',
'type' => 'child',
'parent_id' => '6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b'
]),
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/groups/{id}"
payload := strings.NewReader("{\n \"name\": \"Gym, floor 2\",\n \"type\": \"child\",\n \"parent_id\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\"\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/groups/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Gym, floor 2\",\n \"type\": \"child\",\n \"parent_id\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbital-systems.com/client/groups/{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\": \"Gym, floor 2\",\n \"type\": \"child\",\n \"parent_id\": \"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b\"\n}"
response = http.request(request)
puts response.read_body{
"id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"name": "Gym, floor 2",
"type": "child",
"parent_id": "6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b",
"created_at": "2026-03-14T09:12:44.000Z",
"updated_at": "2026-10-28T17:03:10.000Z"
}{
"message": "Invalid Group",
"statusCode": 400,
"name": "InvalidParameterError"
}{
"message": "Unauthorized.",
"statusCode": 401,
"name": "UnauthorizedError"
}{
"message": "Group not found.",
"statusCode": 404,
"name": "NotFoundError"
}{
"message": "Internal server error"
}Authorizations
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
The group ID
Body
application/json
Response
Group updated successfully
Unique ID of the group.
Example:
"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
Name of the group.
Example:
"Gym, floor 2"
Kind of group, as set when it was created. A group of type root can’t be changed or deleted.
Example:
"child"
ID of the parent group.
Example:
"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b"
When the record was created (ISO 8601).
Example:
"2026-03-14T09:12:44.000Z"
When the record was last changed (ISO 8601).
Example:
"2026-10-28T17:03:10.000Z"
Was this page helpful?