---
title: "Pin Message (Realtime)"
slug: "pin-message-realtime"
updated: 2026-05-14T20:13:42Z
published: 2026-05-14T21:50:48Z
canonical: "developer.rocket.chat/pin-message-realtime"
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Pin Message (Realtime)

![](https://cdn.us.document360.io/27ca1fd4-36d7-4cde-b4eb-97fc1652954c/Images/Documentation/Deprecated.svg)

[Pin](https://docs.rocket.chat/v1/docs/message-actions#pin-messages) a message.

| Method | Requires Auth | Setting |
| --- | --- | --- |
| `pinMessage` | Yes | `Message_AllowPinning` |

## Payload parameters

| Argument | Example | Required | Description |
| --- | --- | --- | --- |
| `messageObject` | ```json { "_id": "298gMs93982Le9A7pZjo2D2iB", "rid": "64a1f373376181965ab77f54", "msg": "Whats 4*!", "ts": { "$date": 1688618709566 }, "u": { "_id": "LFdhbcNHx5zsMA7T4", "username": "test.rc", "name": "Test RC" }, "_updatedAt": { "$date": 1688618709891 }, "urls": [], "mentions": [], "channels": [], "md": [ { "type": "PARAGRAPH", "value": [ { "type": "PLAIN_TEXT", "value": "Whats 4*!" } ] } ] } ``` | Required | The message object |

## Example call

```json
{
    "msg": "method",
    "method": "pinMessage",
    "id": "109",
    "params": [ {
        "_id": "298gMs93982Le9A7pZjo2D2iB",
        "rid": "64a1f373376181965ab77f54",
        "msg": "Whats 4*!",
        "ts": {
            "$date": 1688618709566
        },
        "u": {
            "_id": "LFdhbcNHx5zsMA7T4",
            "username": "test.rc",
            "name": "Test RC"
        },
        "_updatedAt": {
            "$date": 1688618709891
        },
        "urls": [],
        "mentions": [],
        "channels": [],
        "md": [
            {
                "type": "PARAGRAPH",
                "value": [
                    {
                        "type": "PLAIN_TEXT",
                        "value": "Whats 4*!"
                    }
                ]
            }
        ]
    } ]
}
```

## Example response

```json
{
    "msg": "result",
    "id": "109",
    "result": {
        "_id": "64a64761605f9022b067fa3a",
        "t": "message_pinned",
        "rid": "64a1f373376181965ab77f54",
        "ts": {
            "$date": 1688618849979
        },
        "msg": "",
        "u": {
            "_id": "LFdhbcNHx5zsMA7T4",
            "username": "test.rc",
            "name": "Test RC"
        },
        "groupable": false,
        "attachments": [
            {
                "text": "Whats 4*!",
                "author_name": "test.rc",
                "author_icon": "/avatar/test.rc",
                "ts": {
                    "$date": 1688618709566
                },
                "attachments": []
            }
        ],
        "_updatedAt": {
            "$date": 1688618849989
        }
    }
}
```