Liveblocks icon

Liveblocks

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

User → Update Room Subscription Settings

AI-generated

Summary

Update the subscription settings for a specified user in a given Liveblocks room, controlling thread and text mention notification preferences.

Inputs

  • Room ID (required) — The identifier of the Liveblocks room to update subscription settings for.
  • User ID (required) — The identifier of the user whose room subscription settings are being updated.
  • Threads (required) — Sets the thread notification preference with options: 'All', 'Replies and Mentions', or 'None'.
  • Text Mentions (required) — Sets the text mention notification preference with options: 'Mine' or 'None'.

Output shape

a JSON object representing the updated room subscription settings for the user.

The updated settings reflect the chosen thread and text mention preferences in the specified room for the user. The operation requires both Room ID and User ID.

Examples

Example 1: Update a user's room subscription to receive all thread notifications and text mentions only for their own mentions.

Set 'Room ID' and 'User ID' to target the specific user and room, set 'Threads' to 'all', and 'Text Mentions' to 'mine'.

Links

Discussion