Pin a message
updatesTooLong#e317af7e = Updates;
updateShortMessage#313bc7f8 flags:# out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true id:int user_id:long message:string pts:int pts_count:int date:int fwd_from:flags.2?MessageFwdHeader via_bot_id:flags.11?long reply_to:flags.3?MessageReplyHeader entities:flags.7?Vector<MessageEntity> ttl_period:flags.25?int = Updates;
updateShortChatMessage#4d6deea5 flags:# out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true id:int from_id:long chat_id:long message:string pts:int pts_count:int date:int fwd_from:flags.2?MessageFwdHeader via_bot_id:flags.11?long reply_to:flags.3?MessageReplyHeader entities:flags.7?Vector<MessageEntity> ttl_period:flags.25?int = 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#9015e101 flags:# out:flags.1?true id:int pts:int pts_count:int date:int media:flags.9?MessageMedia entities:flags.7?Vector<MessageEntity> ttl_period:flags.25?int = 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
Possible errors
| Code |
Type |
Description |
| 400 |
BOT_ONESIDE_NOT_AVAIL |
Bots can't pin messages in PM just for themselves. |
| 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_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 |
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. |
Bots can use this method