editForumTopic()
Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. 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 |
message_thread_id | number | required | Unique identifier for the target message thread of the forum topic |
name | string | optional | New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept. |
icon_custom_emoji_id | string | optional | New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept. |
returns
boolean
usage in yaebal
not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.
import type { EditForumTopicParams } from "@yaebal/types";
await bot.api.call<boolean>("editForumTopic", {
chat_id: 123456789,
message_thread_id: 1,
} satisfies EditForumTopicParams);context shortcut
also available as ctx.editForumTopic() on
16
context types — see @yaebal/contexts.
/** Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success. */
ctx.editForumTopic(params: Omit<EditForumTopicParams, "chat_id">)official Bot API docs: https://core.telegram.org/bots/api/#editforumtopic