Skip to content

js-bao-wss-client


js-bao-wss-client / CreateGroupParams

Interface: CreateGroupParams ​

Parameters for groups.create().

Properties ​

description? ​

optional description?: string

Optional human-readable description of the group's purpose


groupId? ​

optional groupId?: string

A unique identifier for the group within its type. Optional — when omitted, the server assigns a ULID and returns it in the response.


groupType ​

groupType: string

The type category for the group (e.g., "team", "organization")


name ​

name: string

Display name for the group

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30