Sign in
Notifications

Update room notification settings

Changed on

Deprecated. Renamed to /subscription-settings. Read more in our migration guide.

This endpoint updates a user’s notification settings for a specific room. Corresponds to liveblocks.updateRoomNotificationSettings.

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

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/rooms/{roomId}/users/{userId}/notification-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 notification settings.

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

Example response

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

Changes

  • 22a5e987b8c9Revision changes
    • breaking

      request body became required

  • 77cd6a75b2b7Revision changes
    • info

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

    • info

      api tag Notifications added

    • info

      api tag Deprecated removed

    • info

      endpoint deprecated

    • info

      the response property became required for the status

    • info

      the response property became required for the status