Set Room Notifications

Prev Next
Post
/api/v1/rooms.saveNotification

Set the notification settings of a specific room.

Changelog

Version Description
0.63.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
  "roomId": "5of4weEXaH7yncxz9",
  "notifications": {
    "desktopNotifications": "all",
    "disableNotifications": "0",
    "emailNotifications": "nothing",
    "audioNotificationValue": "beep",
    "desktopNotificationDuration": "2",
    "audioNotifications": "all",
    "unreadAlert": "nothing",
    "hideUnreadStatus": "0",
    "mobilePushNotifications": "mentions"
  }
}
Expand All
object
roomId
string Required

The channel's id

notifications
object Required

The object that contains the following parameters.

desktopNotifications
string

The value for desktop notifications. The options are:

  • nothing
  • mentions
  • all
  • default
disableNotifications
string

The value to disable/enable channel's notifications.

The options are:

  • 0
  • 1
emailNotifications
string

The value for email notifications. The options are:

  • nothing
  • mentions
  • all
  • default
audioNotificationValue
string

The value for audio notification sound.

desktopNotificationDuration
string

The value for desktop notification duration.

audioNotifications
string

The value for audio notifications.

The options are:

  • nothing
  • mentions
  • all
  • default
unreadAlert
string

The value for unread alerts notifications.

The options are:

  • nothing
  • mentions
  • all
  • default
hideUnreadStatus
string

The value to disable/enable number of unread messages. The options are:

  • 0
  • 1
mobilePushNotifications
string

The value for mobile push notifications.

The options are:

  • nothing
  • mentions
  • all
  • default
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string