PATCH /users/me/subscriptions/{stream_id}

Update the current user's personal settings for a specific channel they are subscribed to. These settings include color, muting, pinning and per-channel notification settings.

This is a single channel alternative to the bulk endpoint: POST /users/me/subscriptions/properties.

Servers

Path parameters

Name Type Required Description
stream_id Integer Yes

The ID of the channel to access.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
property String Yes

One of the channel properties described below:

  • "color": The hex value of the user's display color for the channel.

  • "is_muted": Whether the channel is muted.
    Changes: As of Zulip 6.0 (feature level 139), updating either "is_muted" or "in_home_view" generates two subscription update events, one for each property, that are sent to clients. Prior to this feature level, updating either property only generated a subscription update event for "in_home_view".
    Prior to Zulip 2.1.0, 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 property.

  • "pin_to_top": Whether to pin the channel at the top of the channel list.

  • "desktop_notifications": Whether to show desktop notifications for all messages sent to the channel.

  • "audible_notifications": Whether to play a sound notification for all messages sent to the channel.

  • "push_notifications": Whether to trigger a mobile push notification for all messages sent to the channel.

  • "email_notifications": Whether to trigger an email notification for all messages sent to the channel.

  • "wildcard_mentions_notify": Whether wildcard mentions trigger notifications as though they were personal mentions in this channel.

Valid values:

  • "audible_notifications"
  • "color"
  • "push_notifications"
  • "wildcard_mentions_notify"
  • "email_notifications"
  • "is_muted"
  • "in_home_view"
  • "desktop_notifications"
  • "pin_to_top"
value Yes

The new value of the property being modified.

If the property is "color", then value is a string representing the hex value of the user's display color for the channel. For all other above properties, value is a boolean.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.