editGeneralForumTopic()

Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics 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 supergroup in the format `@username`
`name`	string	required	New topic name, 1-128 characters

returns

boolean

usage in yaebal

editGeneralForumTopic is directly typed on Api — call it straight off bot.api.

bot.ts

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

await bot.api.editGeneralForumTopic({
  chat_id: 123456789,
  name: "...",
} satisfies EditGeneralForumTopicParams);

context shortcut

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

context shortcut

/** Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights. Returns *True* on success. */
ctx.editGeneralForumTopic(params: Omit<EditGeneralForumTopicParams, "chat_id">)

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