unpinChatMessage¶

Returns: bool

class aiogram.methods.unpin_chat_message.UnpinChatMessage(*, chat_id: int | str, business_connection_id: str | None = None, message_id: int | None = None, **extra_data: Any)[source]¶

Use this method to remove a message from 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#unpinchatmessage

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

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

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}¶: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_post_init(context: Any, /) → None¶: We need to both initialize private attributes and call the user-defined model_post_init method.

message_id: int | None¶: Identifier of the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned.

Usage¶

As bot method¶

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

Method as object¶

Imports:

from aiogram.methods.unpin_chat_message import UnpinChatMessage
alias: from aiogram.methods import UnpinChatMessage

With specific bot¶

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

As reply into Webhook in handler¶

return UnpinChatMessage(...)