pin_chat_message()

Client.pin_chat_message()

Pin 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``) – Identifier of a message to pin.

  • disable_notification (``bool``, *optional*) – 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.

  • both_sides (``bool``, *optional*) – Pass True to pin the message for both sides (you and recipient). Applicable to private chats only. Defaults to False.

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

Returns:

  • :obj:`~pyrogram.types.Message` | ``bool`` (On success, the service message is returned (when applicable),)

  • otherwise, in case a message object couldn’t be returned, True is returned.

Example

# Pin with notification
await app.pin_chat_message(chat_id, message_id)

# Pin without notification
await app.pin_chat_message(chat_id, message_id, disable_notification=True)