Skip to main content
POST
Create a group.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Body

application/json
name
string
required

Globally unique group name within the instance, including soft-deleted groups, whose names remain reserved. It cannot be a UUID; check for an existing group with this exact name before creation.

Example:

"Operations"

ownerId
string
required

Owning user or group id that governs this group. Must identify an existing owner of the type given by ownerType; provide both fields together.

Example:

"22222222-2222-4222-8222-222222222222"

ownerType
enum<string>
required

Owner principal type for the governing ownerId. Provide a matching existing ownerId.

Available options:
USER,
GROUP
Example:

"USER"

category
string

Optional presentation category used to group similar teams.

Example:

"Operations"

desc
string

Operator-visible description shown in group details.

Example:

"Primary operations on-call rotation."

metadata
object | null

Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:
members
string[]

Optional user ids to attach as group members during creation.

Example:

Response

Created.

Last modified on September 5, 2026