Mark messages in a channel as read

POST https://gizmo.zulipchat.com/api/v1/mark_stream_as_read

Mark all the unread messages in a channel 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 the unread messages in a channel as read, given the channel's ID.
result = client.mark_stream_as_read(stream_id)
print(result)

curl -sSX POST https://gizmo.zulipchat.com/api/v1/mark_stream_as_read \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode stream_id=43

Parameters

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"
}