This feature can be invaluable for customizing Zulip's default
settings for notifications or UI to be appropriate for how the
organization is using Zulip. (Note that this only supports
personal preference settings, like when to send push
notifications or what emoji set to use, not profile or
identity settings that naturally should be different for each user).
Note that this endpoint cannot, at present, be used to modify
settings for existing users in any way.
Changes: New in Zulip 5.0 (feature level 96). If any parameters
sent in the request are not supported by this endpoint, an
ignored_parameters_unsupported array will
be returned in the JSON success response.
Whether the user is configured to receive typing notifications from other users.
The server will only deliver typing notifications events to users who for whom this
is enabled.
Changes: New in Zulip 9.0 (feature level 253). Previously, there were
only options to disable sending typing notifications.
fluid_layout_widthbooleanoptional
Example: true
Whether to use the maximum available screen width
for the web app's center panel (message feed, recent conversations) on wide screens.
high_contrast_modebooleanoptional
Example: true
This setting is reserved for use to control variations in Zulip's design
to help visually impaired users.
web_mark_read_on_scroll_policyintegeroptional
Example: 1
Whether or not to mark messages as read when the user scrolls through their
feed.
1 - Always
2 - Only in conversation views
3 - Never
Changes: New in Zulip 7.0 (feature level 175). Previously, there was no
way for the user to configure this behavior on the web, and the Zulip web and
desktop apps behaved like the "Always" setting when marking messages as read.
Must be one of: 1, 2, 3.
web_channel_default_viewintegeroptional
Example: 1
Web/desktop app setting controlling the default navigation
behavior when clicking on a channel link.
1 - Top topic in the channel
2 - Channel feed
Changes: New in Zulip 9.0 (feature level 269). Previously, this
was not configurable, and every user had the "Channel feed" behavior.
Must be one of: 1, 2.
web_font_size_pxintegeroptional
Example: 14
User-configured primary font-size for the web application, in pixels.
Changes: New in Zulip 9.0 (feature level 245). Previously, font size was
only adjustable via browser zoom. Note that this setting was not fully
implemented at this feature level.
web_line_height_percentintegeroptional
Example: 122
User-configured primary line-height for the web application, in percent, so a
value of 120 represents a line-height of 1.2.
Changes: New in Zulip 9.0 (feature level 245). Previously, line height was
not user-configurable. Note that this setting was not fully implemented at this
feature level.
Automatic detection is implementing using the standard prefers-color-scheme
media query.
Must be one of: 1, 2, 3.
enable_drafts_synchronizationbooleanoptional
Example: true
A boolean parameter to control whether synchronizing drafts is enabled for
the user. When synchronization is disabled, all drafts stored in the server
will be automatically deleted from the server.
This does not do anything (like sending events) to delete local copies of
drafts stored in clients.
Whether to display the names of reacting users on a message.
When enabled, clients should display the names of reacting users, rather than
a count, for messages with few total reactions. The ideal cutoff may depend on
the space available for displaying reactions; the official web application
displays names when 3 or fewer total reactions are present with this setting
enabled.
Changes: New in Zulip 6.0 (feature level 125).
web_home_viewstringoptional
Example: "all_messages"
The home view used when opening a new
Zulip web app window or hitting the Esc keyboard shortcut repeatedly.
"recent_topics" - Recent conversations view
"inbox" - Inbox view
"all_messages" - Combined feed view
Changes: New in Zulip 8.0 (feature level 219). Previously, this was
called default_view, which was new in Zulip 4.0 (feature level 42).
Changes: New in Zulip 8.0 (feature level 219). Previously, this was called
escape_navigates_to_default_view, which was new in Zulip 5.0 (feature level 107).
left_side_userlistbooleanoptional
Example: true
Whether the users list on left sidebar in narrow windows.
This feature is not heavily used and is likely to be reworked.
emojisetstringoptional
Example: "google"
The user's configured emoji set,
used to display emoji to the user everywhere they appear in the UI.
The style selected by the user for the right sidebar user list.
1 - Compact
2 - With status
3 - With avatar and status
Changes: New in Zulip 6.0 (feature level 141).
Must be one of: 1, 2, 3.
web_animate_image_previewsstringoptional
Example: "on_hover"
Controls how animated images should be played in the message feed in the web/desktop application.
"always" - Always play the animated images in the message feed.
"on_hover" - Play the animated images on hover over them in the message feed.
"never" - Never play animated images in the message feed.
Changes: New in Zulip 9.0 (feature level 275). Previously, animated images
always used to play in the message feed by default. This setting controls this
behaviour.
Configuration for which channels should be displayed with a numeric unread count in the left sidebar.
Channels that do not have an unread count will have a simple dot indicator for whether there are any
unread messages.
Changes: New in Zulip 7.0 (feature level 168), replacing the
previous realm_name_in_notifications boolean;
true corresponded to Always, and false to Never.
Changes: New in Zulip 5.0 (feature level 99).
Previously, this default was edited using the
default_twenty_four_hour_time parameter to the PATCH /realm endpoint.
Whether other users are allowed to see whether you've
read messages.
Changes: New in Zulip 5.0 (feature level 105).
email_address_visibilityintegeroptional
Example: 1
The policy for which other users
in this organization can see the user's real email address.
1 = Everyone
2 = Members only
3 = Administrators only
4 = Nobody
5 = Moderators only
Changes: New in Zulip 7.0 (feature level 163), replacing the
realm-level setting.
Must be one of: 1, 2, 3, 4, 5.
web_navigate_to_sent_messagebooleanoptional
Example: true
Web/desktop app setting for whether the user's view should
automatically go to the conversation where they sent a message.
Changes: New in Zulip 9.0 (feature level 268). Previously,
this behavior was not configurable.
Response
Example response(s)
Changes: The ignored_parameters_unsupported
array was added as a possible return value for all REST API endpoint
JSON success responses in Zulip 7.0 (feature level 167).