Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

api: Update documentation of subscription properties endpoint. 

This covers the recent field rename as well as the addition of
email_notifications.
This commit is contained in:
Tim Abbott 2019-06-06 12:05:49 -07:00
parent 90a67a6b4f
commit 58c11fd249
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
templates/zerver/api/update-subscription-properties.md
View File

@ -35,8 +35,11 @@ curl -X POST {{ api_url }}/v1/users/me/subscriptions/properties \
The possible values for each `property` and `value` pairs are:
* `color` (string): the hex value of the user's display color for the stream.
* `in_home_view` (boolean): whether the stream should be visible in the home
view (`true`) or muted and thus hidden from the home view (`false`).
* `is_muted` (boolean): whether the stream is
[muted](/help/mute-a-stream). Prior to Zulip 2.1, this feature was
represented by the more confusingly named `in_home_view` (with the
opposite value, `in_home_view=!is_muted`); for
backwards-compatibility, modern Zulip still accepts that value.
* `pin_to_top` (boolean): whether to pin the stream at the top of the stream list.
* `desktop_notifications` (boolean): whether to show desktop notifications
for all messages sent to the stream.
@ -44,6 +47,8 @@ The possible values for each `property` and `value` pairs are:
notification for all messages sent to the stream.
* `push_notifications` (boolean): whether to trigger a mobile push
notification for all messages sent to the stream.
* `email_notifications` (boolean): whether to trigger an email
notification for all messages sent to the stream.
## Response