Star/Unstar Message
    • Dark
      Light
    • PDF

    Star/Unstar Message

    • Dark
      Light
    • PDF

    Article summary

    Starring messages enables users to save them easily for future reference or personal use.

    Method

    Requires Auth

    Setting

    starMessage

    Yes

    Message_AllowStarring

    Payload parameters

    Argument

    Example

    Required

    Description

    message

    {
       "_id": "8gMsLe9ApZjo2D2iB",
       "rid": "64a1f373376181965ab77f54",
       "starred": true
    }

    Required

    The message object.

    The message object contains the following properties:

    _id

    8gMsLe9ApZjo2D2iB

    Required

    The message ID that you want to star or unstar.

    rid

    64a1f373376181965ab77f54

    Required

    The room ID.

    starred

    true

    Required

    It can only be true or false.

    true: Star the message. false: Unstar the message.

    Example call

    {
        "msg": "method",
        "method": "starMessage",
        "id": "21",
        "params": [{
            "_id": "8gMsLe9ApZjo2D2iB",
            "rid": "64a1f373376181965ab77f54",
            "starred": true
        }]
    }

    Example response

    {
        "msg": "result",
        "id": "21",
        "result": true
    }


    Was this article helpful?

    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