Actions83
- AI Copilot Actions
- AI Knowledge Actions
- Attachment Actions
- Comment Actions
- Feed Actions
- Group Actions
- Inbox Actions
- Room Actions
- Storage Actions
- Thread Actions
- User Actions
- Delete Inbox Notification
- Get Inbox Notification
- Delete All Inbox Notifications
- Get Many Inbox Notifications
- Delete Notification Settings
- Get Notification Settings
- Update Notification Settings
- Delete Room Subscription Settings
- Get Room Subscription Settings
- Update Room Subscription Settings
- Get Many Room Subscription Settings
- Yjs Actions
Group → Create
AI-generatedSummary
Create a new group in Liveblocks with a unique identifier, optional member list, organization association, and mention scope setting.
Inputs
- Group ID (required) — Specify a unique identifier for the group to create.
- Member IDs — Provide a JSON array or a comma-separated string of user IDs to include as members in the group.
- Organization ID — Set the organization ID to associate the group with an organization.
- Scope: Mention — Set to true to enable the group's scopes.mention property.
Output shape
a single record containing the newly created group's details as returned by the Liveblocks API
If the API call fails, error details may include the request information if 'Include Request in Error' option is enabled. The output structure depends on Liveblocks API response schema for group creation.
Examples
Example 1: Creating a group with members and mention scope
Provide a unique Group ID, specify Member IDs as a JSON array or comma-separated string, set Organization ID if applicable, and enable 'Scope: Mention' if mentions are needed within the group.