unpin_all_chat_messages()#

Client.unpin_all_chat_messages()#

Use this method to clear 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’ admin right in a supergroup or ‘can_edit_messages’ admin right in a channel.

Usable by Users Bots
Parameters:
  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat.

  • message_thread_id (int, optional) – Unique identifier for the target message thread of the forum topic

Returns:

int – Amount of affected messages

Example

# Unpin all chat messages
await app.unpin_all_chat_messages(chat_id)