Update personal message flags for narrow

POST https://zulip.fotosearch.com/api/v1/messages/flags/narrow

Add or remove personal message flags like read and starred on a range of messages within a narrow.

See also the endpoint for updating flags on specific message IDs.

Changes: New in Zulip 6.0 (feature level 155).

Usage examples

curl -sSX POST https://zulip.fotosearch.com/api/v1/messages/flags/narrow \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode anchor=43 \
    --data-urlencode num_before=4 \
    --data-urlencode num_after=8 \
    --data-urlencode 'narrow=[{"operand": "Denmark", "operator": "stream"}]' \
    --data-urlencode op=add \
    --data-urlencode flag=read

Parameters

Response

Return values

• processed_count: integer

  The number of messages that were within the update range (at most num_before + 1 + num_after).

• updated_count: integer

  The number of messages where the flag's value was changed (at most processed_count).

• first_processed_id: integer | null

  The ID of the oldest message within the update range, or null if the range was empty.

• last_processed_id: integer | null

  The ID of the newest message within the update range, or null if the range was empty.

• found_oldest: boolean

  Whether the update range reached backward far enough to include very oldest message matching the narrow (used by clients doing a bulk update to decide whether to issue another request anchored at first_processed_id).

• found_newest: boolean

  Whether the update range reached forward far enough to include very oldest message matching the narrow (used by clients doing a bulk update to decide whether to issue another request anchored at last_processed_id).

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:

{
    "first_processed_id": 35,
    "found_newest": true,
    "found_oldest": false,
    "last_processed_id": 55,
    "msg": "",
    "processed_count": 11,
    "result": "success",
    "updated_count": 8
}