diff --git a/templates/zerver/api/update-message-flags.md b/templates/zerver/api/update-message-flags.md index 4782570361..9405012172 100644 --- a/templates/zerver/api/update-message-flags.md +++ b/templates/zerver/api/update-message-flags.md @@ -58,6 +58,71 @@ curl -X POST {{ api_url }}/v1/messages/flags \ {generate_api_arguments_table|zulip.yaml|/messages/flags:post} +## Available Flags +
Flag | +Purpose | + + +
---|---|
`read` | ++ Whether the user has read the message. Messages + start out unread (except for messages the user + themself sent using a non-API client) and can + later be marked as read. + | +
`starred` | +Whether the user has [starred this message](/help/star-a-message). | +
`collapsed` | +Whether the user has [collapsed this message](/help/collapse-a-message). | +
`mentioned` | ++ Whether the current user [was + mentioned](/help/mention-a-user-or-group) by + this message, either directly or via a user + group. Not editable. + | +
`wildcard_mentioned` | ++ Whether this message contained [wildcard + mention](/help/mention-a-user-or-group#mention-everyone-on-a-stream) + like @**all**. Not editable. + | +
`mentioned` | ++ Whether the message contains any of the current + user's [configured alert + words](/help/add-an-alert-word). Not editable. + | +
`historical` | ++ True for messages that the user did not receive + at the time they were sent but later was added to + the user's history (E.g. because they starred or + reacted to a message sent to a public stream + before they subscribed to that stream). Not + editable. + | +