zulip/templates/zerver/api/mark-as-read-bulk.md

93 lines
1.6 KiB
Markdown

# Mark all messages as read
{generate_api_description(/mark_all_as_read:post)}
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/mark_all_as_read:post|example}
{tab|curl}
{generate_code_example(curl)|/mark_all_as_read:post|example}
{end_tabs}
## Arguments
{generate_api_arguments_table|zulip.yaml|/mark_all_as_read:post}
## Response
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/mark_all_as_read:post|fixture(200)}
# Mark messages in a stream as read
Mark all the unread messages in a stream as read.
`POST {{ api_url }}/v1/mark_stream_as_read`
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/mark_stream_as_read:post|example}
{tab|curl}
{generate_code_example(curl)|/mark_stream_as_read:post|example}
{end_tabs}
## Arguments
{generate_api_arguments_table|zulip.yaml|/mark_stream_as_read:post}
## Response
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/mark_stream_as_read:post|fixture(200)}
# Mark messages in a topic as read
Mark all the unread messages in a topic as read.
`POST {{ api_url }}/v1/mark_topic_as_read`
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/mark_topic_as_read:post|example}
{tab|curl}
{generate_code_example(curl)|/mark_topic_as_read:post|example}
{end_tabs}
## Arguments
{generate_api_arguments_table|zulip.yaml|/mark_topic_as_read:post}
## Response
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/mark_topic_as_read:post|fixture(200)}