setChatDescription()

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

parameter	type	required	description
`chat_id`	number \| string	required	Unique identifier for the target chat or username of the target channel in the format `@username`
`description`	string	optional	New chat description, 0-255 characters

returns

boolean

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts

import type { SetChatDescriptionParams } from "@yaebal/types";

await bot.api.call<boolean>("setChatDescription", {
  chat_id: 123456789,
} satisfies SetChatDescriptionParams);

context shortcut

also available as ctx.setChatDescription() on 16 context types — see @yaebal/contexts.

context shortcut

/** 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. */
ctx.setChatDescription(params: Omit<SetChatDescriptionParams, "chat_id">)

official Bot API docs: https://core.telegram.org/bots/api/#setchatdescription