Notifications

Update room subscription settings

Changed on

This endpoint updates a user’s subscription settings for a specific room. Corresponds to liveblocks.updateRoomSubscriptionSettings.

post/rooms/{roomId}/users/{userId}/subscription-settings

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/rooms/{roomId}/users/{userId}/subscription-settings
  • Auth: none declared

Path parameters

roomIdstring required

ID of the room

Example:my-room-id
userIdstring required

ID of the user

Example:user-123

Request body

threads'all' | 'replies_and_mentions' | 'none'
textMentions'mine' | 'none'

Example request

{
  "threads": "replies_and_mentions",
  "textMentions": "none"
}

Response

Success. Returns the updated room subscription settings.

threads'all' | 'replies_and_mentions' | 'none' required
textMentions'mine' | 'none' required

Example response

{
  "threads": "all",
  "textMentions": "mine"
}

Changes

    • breaking

      request body became required

    • info

      api operation id post-rooms-roomId-users-userId-subscription-settings removed and replaced with update-room-subscription-settings

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      endpoint added