peyk.platforms.telegram.methods.set_chat_description¶

async peyk.platforms.telegram.methods.set_chat_description(self, chat_id: int | str, description: str | None = None) → bool[source]¶

Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

chat_id – Unique identifier for the target chat or username of the target channel in the format @username
description – New chat description, 0-255 characters

Returns:

Result returned by Telegram on successful execution.

Return type:

bool