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
- https://{subdomain}.zulipchat.com/api/v1
- {server}/api/v1
- https://chat.zulip.org/api/v1
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:
Valid values:
|
value |
Yes |
The new value of the property being modified. If the property is |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.