Home › Methods › Messages › UpdatePinnedMessage
Layer 220

MessagesUpdatePinnedMessage

Pin a message

method Users Bots Business
messages.updatePinnedMessage#d2aaf7ec flags:# silent:flags.0?true unpin:flags.1?true pm_oneside:flags.2?true peer:InputPeer id:int = Updates;

Parameters

Name Type Description
Flags # Flags, see TL conditional fields
Silent flags.0?true Pin the message silently, without triggering a notification
Unpin flags.1?true Whether the message should unpinned or pinned
PmOneside flags.2?true Whether the message should only be pinned on the local side of a one-to-one chat
Peer InputPeer The peer where to pin the message
Id int The message to pin or unpin

Returns

Updates

Possible Errors

Code Type Description
400 BOT_ONESIDE_NOT_AVAIL Bots can't pin messages in PM just for themselves.
400 BUSINESS_CONNECTION_INVALID The connection_id passed to the wrapping invoke With Business Connection call is invalid.
400 BUSINESS_PEER_INVALID Messages can't be set to the specified peer through the current business connection.
400 CHANNEL_PRIVATE You haven't joined this channel/supergroup.
400 CHAT_ADMIN_REQUIRED You must be an admin in this chat to do this.
400 CHAT_INVALID Invalid chat.
400 CHAT_NOT_MODIFIED No changes were made to chat information because the new information you passed is identical to the current information.
403 CHAT_WRITE_FORBIDDEN You can't write in this chat.
400 INPUT_USER_DEACTIVATED The specified user was deleted.
400 MESSAGE_ID_INVALID The provided message id is invalid.
400 PEER_ID_INVALID The provided peer id is invalid.
400 PIN_RESTRICTED You can't pin messages.
400 USER_BANNED_IN_CHANNEL You're banned from sending messages in supergroups/channels.

Gogram Example

// MessagesUpdatePinnedMessage - using Params struct
result, err := client.MessagesUpdatePinnedMessage(&tg.MessagesUpdatePinnedMessageParams{
    Peer: &tg.InputPeerUser{UserID: int64(123456789)},
    Id: 0,

    // Optional fields:
    // Silent: true,
    // Unpin: true,
    // PmOneside: true,
})
if err != nil {
    // handle error
}
// result is *tg.Updates