unpin_chat_message()

Client.unpin_chat_message()

Unpin a message in a group, channel or your own chat. You must be an administrator in the chat for this to work and must have the “can_pin_messages” admin right in the supergroup or “can_edit_messages” admin right in the channel.

Usable by Users Bots
Parameters:

  • chat_id (``int`` | ``str``) – Unique identifier (int) or username (str) of the target chat.

  • message_id (``int``, *optional*) – Identifier of a message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned.

  • business_connection_id (``str``, *optional*) – Unique identifier of the business connection on behalf of which the message will be unpinned.

Returns:

``bool`` (True on success.)

Example

await app.unpin_chat_message(chat_id, message_id)