mirror of https://github.com/zulip/zulip.git
62 lines
1.5 KiB
Markdown
62 lines
1.5 KiB
Markdown
|
# Topic muting
|
||
|
|
|
||
|
|
This endpoint mutes/unmutes a topic within a stream that the current
|
||
|
|
user is subscribed to. Muted topics are displayed faded in the Zulip
|
||
|
|
UI, and are not included in the user's unread count totals.
|
||
|
|
|
||
|
|
`PATCH {{ api_url }}/v1/users/me/subscriptions/muted_topics`
|
||
|
|
|
||
|
|
## Usage examples
|
||
|
|
|
||
|
|
<div class="code-section" markdown="1">
|
||
|
|
<ul class="nav">
|
||
|
|
<li data-language="python">Python</li>
|
||
|
|
<li data-language="curl">curl</li>
|
||
|
|
</ul>
|
||
|
|
<div class="blocks">
|
||
|
|
|
||
|
|
<div data-language="curl" markdown="1">
|
||
|
|
|
||
|
|
```
|
||
|
|
curl -X PATCH {{ api_url }}/v1/users/me/subscriptions/muted_topics \
|
||
|
|
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
|
||
|
|
-d "stream=Verona"
|
||
|
|
-d "topic=dinner"
|
||
|
|
-d "op=add"
|
||
|
|
```
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div data-language="python" markdown="1">
|
||
|
|
|
||
|
|
{generate_code_example(python)|/users/me/subscriptions/muted_topics:patch|example}
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
## Arguments
|
||
|
|
|
||
|
|
{generate_api_arguments_table|zulip.yaml|/users/me/subscriptions/muted_topics:patch}
|
||
|
|
|
||
|
|
## Response
|
||
|
|
|
||
|
|
#### Example response
|
||
|
|
|
||
|
|
A typical successful JSON response may look like:
|
||
|
|
|
||
|
|
{generate_code_example|/users/me/subscriptions/muted_topics:patch|fixture(200)}
|
||
|
|
|
||
|
|
|
||
|
|
An example JSON response for when an `add` operation is requested for a topic
|
||
|
|
that has already been muted:
|
||
|
|
|
||
|
|
{generate_code_example|/users/me/subscriptions/muted_topics:patch|fixture(400_topic_already_muted)}
|
||
|
|
|
||
|
|
An example JSON response for when a `remove` operation is requested for a
|
||
|
|
topic that had not been previously muted:
|
||
|
|
|
||
|
|
{generate_code_example|/users/me/subscriptions/muted_topics:patch|fixture(400_topic_not_muted)}
|