set_chat_description()#

Client.set_chat_description()#

Change the description of a supergroup or a channel. You must be an administrator in the chat for this to work and must have the appropriate admin rights.

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

  • description (str) – New chat description, 0-255 characters.

Returns:

bool – True on success.

Raises:

ValueError – if a chat_id doesn’t belong to a supergroup or a channel.

Example

await app.set_chat_description(chat_id, "New Description")