Pin a message
Method schema is available as of layer 87. Switch ยป
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