Liveblocks icon

Liveblocks

Call the Liveblocks REST API (rooms, comments, feeds, Yjs, AI, and more)

Group → Remove Members

AI-generated

Summary

Remove specified members from a group identified by the given Group ID.

Inputs

  • Group ID (required) — The unique identifier of the group from which members will be removed.
  • Member IDs (required) — A JSON array or comma-separated string listing the IDs of members to remove from the group.
  • Include Request in Error — Optional boolean to include the outgoing request details in error messages for debugging failed API calls.

Output shape

a JSON object representing the updated group membership state or API response confirming member removal

Errors may include debugging information if 'Include Request in Error' is enabled. The exact response shape depends on the Liveblocks API's removeGroupMembers endpoint.

Examples

Example 1: Remove members with IDs 123 and 456 from group 'abc123'

Set 'Group ID' to 'abc123', 'Member IDs' to '["123","456"]' or '123,456'

Links

Discussion