Skip to main content
POST
Create group

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" }.

Body

application/json
name
string

Name of the group.

Example:

"Gym, floor 2"

type
string

Kind of group, such as child.

Example:

"child"

parent_id
string

ID of the parent group. You must own it.

Example:

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

Response

Group created successfully

id
string

Unique ID of the group.

Example:

"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"

name
string

Name of the group.

Example:

"Gym, floor 2"

type
string

Kind of group, as set when it was created. A group of type root can’t be changed or deleted.

Example:

"child"

parent_id
string

ID of the parent group.

Example:

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

created_at
string

When the record was created (ISO 8601).

Example:

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

updated_at
string

When the record was last changed (ISO 8601).

Example:

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