Set preferences for your account. If you want to edit another user's preferences, you need the permission edit-other-user-info.
Changelog
| Version | Description |
|---|---|
| 2.3.0 | Added desktopNotificationRequireInteraction property. |
The authenticated user ID.
The authenticated user token.
{
"userId": "rbAXPnMktTFbNpwtJ",
"data": {
"language": "en",
"newRoomNotification": "door",
"newMessageNotification": "chime",
"muteFocusedConversations": true,
"clockMode": 0,
"useEmojis": true,
"convertAsciiEmoji": true,
"saveMobileBandwidth": true,
"collapseMediaByDefault": true,
"autoImageLoad": true,
"emailNotificationMode": "mentions",
"unreadAlert": true,
"notificationsSoundVolume": 0,
"desktopNotifications": "mentions",
"pushNotifications": "mentions",
"enableAutoAway": true,
"highlights": [
"[\"deploy\", \"docker\"]"
],
"messageViewMode": 0,
"hideUsernames": true,
"hideRoles": true,
"displayAvatars": true,
"hideFlexTab": true,
"sendOnEnter": "string",
"idleTimeLimit": 300,
"sidebarShowFavorites": true,
"sidebarShowUnread": true,
"sidebarSortby": "string",
"sidebarViewMode": "string",
"sidebarDisplayAvatar": true,
"sidebarGroupByType": true,
"dontAskAgainList": [
{}
],
"notifyCalendarEvents": false,
"themeAppearence": "auto"
}
}The user ID whose preferences you want to change. If an ID is not provided, the preferences will be set for the user who is sending the request.
The object with the following preference details.
The preferred language for the user.
Set the sound for new room notifications. The notification sounds are customizable, you can check the preferences in your workspace account for the list of options available.
New message notification sound. The notification sounds are customizable, you can check the preferences in your workspace account for the list of options available.
When set to true, open and active rooms will not create notification sounds.
The valid display formats for the clock. You can enter the values 0, 1, or 2.
0: System default1: 12-hour clock2: 24-hour clock
A boolean value that indicates whether the user has enabled the option to use emojis.
A boolean value that indicates whether the user has enabled the option to convert ASCII emojis.
A boolean value that indicates whether the user has enabled the option to save mobile bandwidth.
A boolean value that indicates whether the user has enabled the option to collapse media by default.
A boolean value indicates whether the user has enabled the option to load images automatically.
The preferred mode for email notifications. The options are:
all: Get desktop notifications for all messages.mentions: Get the notifications only for mentions.nothing: Get no desktop notifications.
A boolean value indicates whether the user has enabled the option.
The sound volume for notifications.
The type of desktop notifications.
all: Get desktop notifications for all messages.mentions: Get the notifications only for mentions.nothing: Get no desktop notifications.
The type of push notifications.
all: Get push notifications for all messages.mentions: Get the notifications only for mentions.nothing: Get no push notifications.
A boolean value that indicates whether the user has enabled the option to update the status as away after a certain amount of idle time.
The message highlights section. You will be notified when someone mentions a word or phrase that you add here. Highlight words are not case-sensitive.
The preferred view mode for the messages i. The available options are:
0- Normal1- Cozy2- Compact
A boolean value that indicates whether the user has enabled the option to hide usernames.
A boolean value that indicates whether the user has enabled the option to hide roles.
A boolean value that indicates whether the user has enabled the option to display user avatars.
A boolean value that indicates whether the user has enabled the option to automatically close the right sidebar in rooms when you click outside them.
Set how you want the Enter key to behave when sending messages.
normal- Send messages with the Enter key.alternative- Send messages with Enter + Ctrl/Alt/Shift/Cmd.desktop- Send messages with Enter only on the desktop.
The time limit that is to be considered as idle time. After this time, the user status changes to away.
A boolean value that indicates whether the user has enabled the option to show favorites on the sidebar.
A boolean value that indicates whether the user has enabled the option to show unread messages in the sidebar.
To sort the messages in the sidebar alphabetically or by activity. The values can be:
activityalphabetical
The view mode of the sidebar. The values can be:
extendedmediumcondensed
A boolean value that indicates whether the user has enabled the option to display avatars in the sidebar.
A boolean value that indicates whether the user has enabled the option to show the grouped values in the sidebar.
This field stores all the "warnings" a user opted not to be displayed again. An example where this works is when hiding a room. "dontAskAgainList":[{"action":"hideRoom","label":"Hide"}]"
If you are using Outlook Calendar in your workspace, you can enable or disable calendar event notifications using this parameter.
Set your preferrred workspace theme. The options are:
lightdarkautohigh-contrast
Control the volume for all sounds coming from your workspace.
When replying to a thread, select how your replies should be sent to the room:
never: Thread replies are not sent to the channel.always: Thread replies are sent to the channel.default: Defaults to the workspace settings set by the admin.
When set to true, notifications will remain in the notification panel until they are visited or closed.
When set to true, all replies under a thread will also be displayed directly in the main room. When disabled, they're displayed based on the sender's choice.
Set the font size. The options are:
smallmediumlarge
Set this option to true to get an email notification whenever a login is made to your account.
Set to true to always export the transcript as PDF at the end of Omnichannel conversations.
Set to true to always send the transcript to contacts at the end of conversations.
Set to true to redirect agents to the home page after closing a conversation.
If you are using the Rocket.Chat Voice feature, you can set this parameter to true for mobile call notifications.
OK
{
"preferences": {
"enableAutoAway": true,
"idleTimeLimit": 300,
"desktopNotificationRequireInteraction": false,
"desktopNotifications": "default",
"pushNotifications": "all",
"unreadAlert": false,
"useEmojis": true,
"convertAsciiEmoji": true,
"autoImageLoad": true,
"saveMobileBandwidth": true,
"collapseMediaByDefault": false,
"hideUsernames": false,
"hideRoles": false,
"hideFlexTab": false,
"displayAvatars": true,
"sidebarGroupByType": true,
"sidebarViewMode": "condensed",
"sidebarDisplayAvatar": true,
"sidebarShowUnread": true,
"sidebarSortby": "activity",
"showMessageInMainThread": false,
"sidebarShowFavorites": true,
"sendOnEnter": "normal",
"messageViewMode": 0,
"emailNotificationMode": "mentions",
"newRoomNotification": "door",
"newMessageNotification": "chime",
"muteFocusedConversations": true,
"notificationsSoundVolume": 100,
"enableMessageParserEarlyAdoption": false,
"mobileNotifications": "default",
"desktopNotificationDuration": 0,
"dontAskAgainList": [],
"highlights": [],
"language": "en"
}
}Bad Request
{
"success": false,
"error": "must have required property 'data' [invalid-params]",
"errorType": "invalid-params"
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}