Pin Message
    • Dark
      Light
    • PDF

    Pin Message

    • Dark
      Light
    • PDF

    Article summary

    Pin a message.

    Method

    Requires Auth

    Setting

    pinMessage

    Yes

    Message_AllowPinning

    Payload parameters

    Argument

    Example

    Required

    Description

    messageObject

    {
            "_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

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

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


    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence