Skip to main content
POST
Create an embed group
🔒 Admin only. Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role. Creates a group inside the embed tenant. The name must be unique within the tenant and may not start with system: (that prefix is reserved for platform-managed groups). The group is immediately usable as a tenantGroups entry when generating a creator-mode embed session, and reaches the data model as system:tenant:{embedTenantName}:{name}. Returns 400 if the name is taken or reserved.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

embedTenantName
string
required

Name of the embed tenant (the embedTenantName used to generate embed sessions).

Body

application/json

CreateEmbedGroupInput

name
string
required

Group name, unique within the embed tenant. The system: prefix is reserved and rejected.

Required string length: 1 - 100
description
string | null

Optional human-readable description.

Maximum string length: 500

Response

200 - application/json
id
integer
required
name
string
required
description
string | null
userCount
integer | null