peyk.platforms.telegram.methods.unpin_chat_message

async peyk.platforms.telegram.methods.unpin_chat_message(self, chat_id: int | str, message_id: int | None = None) → bool

Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the ‘can_pin_messages’ right or the ‘can_edit_messages’ right to unpin messages in groups and channels respectively. Returns True on success.

Parameters:

• chat_id – Unique identifier for the target chat or username of the target channel in the format @username

• message_id – 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.

Returns:

Result returned by Telegram on successful execution.

Return type:

bool