Pin a message

POST https://connect.suryojasvi.com/api/v1/messages/{message_id}/pin

Pin a message to its conversation, for everyone in it: to its channel, for a channel message, or to its direct message conversation. Anyone who can read the message can pin it. Pinning a message already pinned changes nothing.

Changes: New in Zulip 13.0 (feature level ZF-3964f5).

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/messages/43/pin \
    -u EMAIL_ADDRESS:API_KEY

Parameters

message_id integer required in path

Example: 43

The target message's ID.


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