Mark messages in a topic as read
POST https://qmech2021.zulip.cs.aalto.fi/api/v1/mark_topic_as_read
Mark all the unread messages in a topic as read.
Changes: Deprecated; clients should use the update personal message
flags for narrow endpoint instead
as this endpoint will be removed in a future release.
Usage examples
#!/usr/bin/env python3
import zulip
# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")
# Mark unread messages in a given topic/channel as read.
result = client.mark_topic_as_read(stream_id, topic_name)
print(result)
curl -sSX POST https://qmech2021.zulip.cs.aalto.fi/api/v1/mark_topic_as_read \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
--data-urlencode stream_id=43 \
--data-urlencode 'topic_name=new coffee machine'
Parameters
stream_id integer required
Example: 43
The ID of the channel to access.
topic_name string required
Example: "new coffee machine"
The name of the topic whose messages should be marked as read.
Note: When the value of realm_empty_topic_display_name found in
the POST /register response is used for this
parameter, it is interpreted as an empty string.
Changes: Before Zulip 10.0 (feature level 334), empty string
was not a valid topic name for channel messages.
Response
Example response(s)
Changes: As of Zulip 7.0 (feature level 167), if any
parameters sent in the request are not supported by this
endpoint, a successful JSON response will include an
ignored_parameters_unsupported array.
A typical successful JSON response may look like:
{
"msg": "",
"result": "success"
}