pinChatMessage
Pins a message in a chat.
Returns: On success, returns True.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
business_connection_id | String | Optional | Business connection ID |
chat_id | Integer or String | Yes | Chat ID |
message_id | Integer | Yes | Message ID |
disable_notification | Boolean | Optional | Send silently |
Example request
curl
curl -s -X POST "https://api.telegram.org/bot$TOKEN/pinChatMessage" \
-H "Content-Type: application/json" \
-d '{"chat_id":123456789,"message_id":42}'
Python
import requests
TOKEN = "123456789:AAEexampleTokenReplaceWithYours"
resp = requests.post(
f"https://api.telegram.org/bot{TOKEN}/pinChatMessage",
json={
"chat_id": 123456789,
"message_id": 42
},
timeout=30,
)
print(resp.json())
JavaScript
const TOKEN = "123456789:AAEexampleTokenReplaceWithYours";
const res = await fetch(`https://api.telegram.org/bot${TOKEN}/pinChatMessage`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
"chat_id": 123456789,
"message_id": 42
}),
});
console.log(await res.json());
Step-by-step guide: How to Create a Telegram Bot: Step by Step with BotFather and Python
Related methods
banChatMemberBans a chat member.unbanChatMemberUnbans a chat member.restrictChatMemberRestricts a chat member.promoteChatMemberPromotes a chat member to administrator.setChatAdministratorCustomTitleSets a custom title for an administrator.banChatSenderChatBans a channel in a group/supergroup.unbanChatSenderChatUnbans a channel in a group/supergroup.unpinChatMessageUnpins a message in a chat.unpinAllChatMessagesUnpins all messages in a chat.setChatMemberTagSets a chat member tag (Bot API 9.5).