Star a direct message conversation

POST https://connect.suryojasvi.com/api/v1/users/me/starred_direct_message_conversations

Star or unstar a direct message conversation for the requesting user. A starred conversation is one the user wants kept in view, whether or not anything in it is unread; it is listed in starred_direct_message_conversations.

Changes: New in Zulip 13.0 (feature level ZF-3d7d0b).

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX POST https://connect.suryojasvi.com/api/v1/users/me/starred_direct_message_conversations \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode 'user_ids=[9, 10]' \
    --data-urlencode starred=true

Parameters

user_ids (integer)[] required

Example: [9, 10]

The IDs of the conversation's participants. The requesting user may be included or left out; a conversation with oneself is named by the requesting user's ID alone.


starred boolean required

Example: true

Whether the conversation should be starred.


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