Get User's Preferences
- Print
- DarkLight
- PDF
Get User's Preferences
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/users.getPreferences
Gets all the preferences of the authenticated user in the workspace.
Header parameters
X-Auth-Token
stringRequired
The authenticated user token.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The authenticated user ID.
ExamplerbAXPnMktTFbNpwtJ
Responses
200
OK
Success Example
{
"preferences": {
"newRoomNotification": "door",
"newMessageNotification": "chime",
"muteFocusedConversations": true,
"useEmojis": true,
"convertAsciiEmoji": true,
"saveMobileBandwidth": true,
"collapseMediaByDefault": false,
"autoImageLoad": true,
"emailNotificationMode": "all",
"roomsListExhibitionMode": "category",
"unreadAlert": true,
"notificationsSoundVolume": 100,
"desktopNotifications": "default",
"mobileNotifications": "default",
"enableAutoAway": true,
"highlights": [],
"desktopNotificationDuration": 0,
"viewMode": 0,
"hideUsernames": false,
"hideRoles": false,
"hideAvatars": false,
"hideFlexTab": false,
"sendOnEnter": "normal",
"roomCounterSidebar": false
},
"success": true
}object
preferences
object
newRoomNotification
string
newMessageNotification
string
muteFocusedConversations
boolean
useEmojis
boolean
convertAsciiEmoji
boolean
saveMobileBandwidth
boolean
collapseMediaByDefault
boolean
autoImageLoad
boolean
emailNotificationMode
string
roomsListExhibitionMode
string
unreadAlert
boolean
notificationsSoundVolume
integer
desktopNotifications
string
mobileNotifications
string
enableAutoAway
boolean
highlights
Array of object
object
desktopNotificationDuration
integer
viewMode
integer
hideUsernames
boolean
hideRoles
boolean
hideAvatars
boolean
hideFlexTab
boolean
sendOnEnter
string
roomCounterSidebar
boolean
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?