mirror of https://github.com/zulip/zulip.git
85 lines
1.7 KiB
Markdown
85 lines
1.7 KiB
Markdown
|
# Update a message's flags
|
||
|
|
|
||
|
|
Add or remove flags in a list of messages.
|
||
|
|
|
||
|
|
`POST {{ api_url }}/v1/messages/flags`
|
||
|
|
|
||
|
|
For updating the `read` flag on common collections of messages, see also
|
||
|
|
the
|
||
|
|
[special endpoints for marking message as read in bulk](api/mark-as-read-bulk).
|
||
|
|
|
||
|
|
## Usage examples
|
||
|
|
|
||
|
|
<div class="code-section" markdown="1">
|
||
|
|
<ul class="nav">
|
||
|
|
<li data-language="python">Python</li>
|
||
|
|
<li data-language="javascript">JavaScript</li>
|
||
|
|
<li data-language="curl">curl</li>
|
||
|
|
</ul>
|
||
|
|
<div class="blocks">
|
||
|
|
|
||
|
|
<div data-language="curl" markdown="1">
|
||
|
|
|
||
|
|
```
|
||
|
|
curl -X POST {{ api_url }}/v1/messages/flags \
|
||
|
|
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
|
||
|
|
-d "messages=[4,8,15]" \
|
||
|
|
-d "op=add" \
|
||
|
|
-d "flag=starred"
|
||
|
|
```
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div data-language="python" markdown="1">
|
||
|
|
|
||
|
|
{generate_code_example(python)|/messages/flags:post|example}
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div data-language="javascript" markdown="1">
|
||
|
|
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).
|
||
|
|
```js
|
||
|
|
const zulip = require('zulip-js');
|
||
|
|
|
||
|
|
// Download zuliprc-dev from your dev server
|
||
|
|
const config = {
|
||
|
|
zuliprc: 'zuliprc-dev',
|
||
|
|
};
|
||
|
|
|
||
|
|
const flagParams = {
|
||
|
|
messages: [4, 8, 15],
|
||
|
|
flag: 'read',
|
||
|
|
};
|
||
|
|
|
||
|
|
zulip(config).then((client) => {
|
||
|
|
// Add the "read" flag to messages with IDs 4, 8 and 15
|
||
|
|
client.messages.flags.add(flagParams)
|
||
|
|
.then(console.log)
|
||
|
|
|
||
|
|
// Remove the "read" flag from said messages
|
||
|
|
client.messages.flags.remove(flagParams)
|
||
|
|
.then(console.log);
|
||
|
|
});
|
||
|
|
```
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
## Arguments
|
||
|
|
|
||
|
|
{generate_api_arguments_table|zulip.yaml|/messages/flags:post}
|
||
|
|
|
||
|
|
## Response
|
||
|
|
|
||
|
|
#### Return values
|
||
|
|
|
||
|
|
* `messages`: An array with the IDs of the modified messages.
|
||
|
|
|
||
|
|
#### Example response
|
||
|
|
|
||
|
|
A typical successful JSON response may look like:
|
||
|
|
|
||
|
|
{generate_code_example|/messages/flags:post|fixture(200)}
|