Sign in
Notifications

Update notification settings

Changed on

This endpoint updates a user's notification settings for the project. Corresponds to liveblocks.updateNotificationSettings.

post/users/{userId}/notification-settings

Request

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

Path parameters

userIdstring required

ID of the user

Example:user-123

Request body

Example request

{
  "email": {
    "thread": true,
    "textMention": false
  },
  "slack": {
    "textMention": false
  },
  "webPush": {
    "thread": true
  }
}

Response

Success. Returns the updated notification settings.

Example response

{
  "email": {
    "thread": true,
    "textMention": false,
    "$customNotification": true
  },
  "slack": {
    "thread": true,
    "textMention": true,
    "$customNotification": false
  },
  "teams": {
    "thread": false,
    "textMention": true,
    "$customNotification": true
  },
  "webPush": {
    "thread": true,
    "textMention": true,
    "$customNotification": false
  }
}

Changes