messages.updatePinnedMessage

Pin a message

updatesTooLong#e317af7e = Updates;
updateShortMessage#2296d2c8 flags:# out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true id:int user_id:int message:string pts:int pts_count:int date:int fwd_from:flags.2?MessageFwdHeader via_bot_id:flags.11?int reply_to:flags.3?MessageReplyHeader entities:flags.7?Vector<MessageEntity> = Updates;
updateShortChatMessage#402d5dbb flags:# out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true id:int from_id:int chat_id:int message:string pts:int pts_count:int date:int fwd_from:flags.2?MessageFwdHeader via_bot_id:flags.11?int reply_to:flags.3?MessageReplyHeader entities:flags.7?Vector<MessageEntity> = Updates;
updateShort#78d4dec1 update:Update date:int = Updates;
updatesCombined#725b04c3 updates:Vector<Update> users:Vector<User> chats:Vector<Chat> date:int seq_start:int seq:int = Updates;
updates#74ae4240 updates:Vector<Update> users:Vector<User> chats:Vector<Chat> date:int seq:int = Updates;
updateShortSentMessage#11f1331c flags:# out:flags.1?true id:int pts:int pts_count:int date:int media:flags.9?MessageMedia entities:flags.7?Vector<MessageEntity> = Updates;
---functions---
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
pm_oneside 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

Result

Updates

Both users and bots can use this method

This method can be invoked over a business connection ยป

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 invokeWithBusinessConnection 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.

Related pages

Business

Users can turn their Telegram account into a business account, gaining access to business features such as opening hours, location, quick replies, automated messages, custom start pages, chatbot support, and more.