pinChatMessage¶

Returns: bool

class aiogram.methods.pin_chat_message.PinChatMessage(*, chat_id: int | str, message_id: int, business_connection_id: str | None = None, disable_notification: bool | None = None, **extra_data: Any)[source]¶

Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ administrator right in a supergroup or ‘can_edit_messages’ administrator right in a channel. Returns True on success.

Source: https://core.telegram.org/bots/api#pinchatmessage

chat_id: ChatIdUnion¶: Unique identifier for the target chat or username of the target channel (in the format @channelusername)

message_id: int¶: Identifier of a message to pin

business_connection_id: str | None¶: Unique identifier of the business connection on behalf of which the message will be pinned

disable_notification: bool | None¶: Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.

Usage¶

As bot method¶

result: bool = await bot.pin_chat_message(...)

Method as object¶

Imports:

from aiogram.methods.pin_chat_message import PinChatMessage
alias: from aiogram.methods import PinChatMessage

With specific bot¶

result: bool = await bot(PinChatMessage(...))

As reply into Webhook in handler¶

return PinChatMessage(...)