Skip to main content
POST
Create user invite

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
email
string<email>

Email address of the Orbital user to invite. They must already have an account.

Example:

"friend@example.com"

group_id
string

ID of your group, to share all your devices. Set this or device_id.

Example:

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

device_id
string

ID of a device you own, to share only that device. Set this or group_id.

Example:

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

accepted
boolean

Set to true to accept an invite you received.

Example:

true

updated_at
string

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

Example:

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

role
enum<string>

Access to give: user or maintenance. Defaults to user. Only the person who sent the invite can change it.

Available options:
maintenance,
user
Example:

"user"

Response

Invite created successfully

id
string<uuid>

Unique ID of the invite.

Example:

"5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a"

inviter
string

User ID of the person who sent the invite.

Example:

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

inviter_email
string<email>

Email address of the person who sent the invite.

Example:

"owner@example.com"

email
string<email>

Email address of the person invited.

Example:

"friend@example.com"

group_id
string

ID of the shared group, when a group is shared.

Example:

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

accepted
boolean

Whether the invite has been accepted.

Example:

false

device_id
string

ID of the shared device, when a single device is shared.

Example:

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

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"

role
enum<string>

Access the invite gives: user or maintenance. Missing means user.

Available options:
maintenance,
user
Example:

"user"