Skip to main content
POST
/
api
/
notification-sounds
/
preferences
Update user notification sound preferences
curl --request POST \
  --url https://your-instance.example.com/api/notification-sounds/preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "volume": 0.75
}
'
{
  "success": true,
  "data": {
    "enabled": true,
    "volume": 0.75
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
enabled
boolean
required

When true, the client plays the notification sound on new messages.

​
volume
number

Output volume 0-1.

Required range: 0 <= x <= 1

Response

Notification preferences updated

​
success
enum<boolean>
required
Available options:
true
​
data
object
required