Liveblocks icon

Liveblocks

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

Room → Update

AI-generated

Summary

Update permissions, metadata, and access controls for a specified Liveblocks room by its ID.

Inputs

  • Room ID (required) — The unique identifier of the Liveblocks room to update.
  • Clear Default Accesses — If set to true, clears all default access permissions by setting them to null.
  • Default Accesses — Array of default permissions to assign to the room when not clearing default accesses. Permissions include room:write, room:read, room:presence:write, and comments:write.
  • Users Access — Collection of per-user permission entries with each entry specifying the user or group ID, an option to clear access, and permissions to grant.
  • Groups Access — Collection of per-group permission entries with each entry specifying the user or group ID, an option to clear access, and permissions to grant.
  • Metadata — A JSON object mapping keys to values (string, string array, or null) to update the room's metadata.
  • Include Request in Error — When true, includes detailed request information in error messages for debugging API call failures.

Output shape

a single JSON object representing the updated Liveblocks room resource

The returned object reflects the updated state of the room, including permissions and metadata. Errors may include detailed request info if enabled via Include Request in Error.

Links

Discussion