createForumTopic()

Use this method to create 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 right. Returns information about the created topic as a ForumTopic object.

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	Topic name, 1-128 characters
`icon_color`	number	optional	Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F).
`icon_custom_emoji_id`	string	optional	Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.

returns

ForumTopic

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 { CreateForumTopicParams, ForumTopic } from "@yaebal/types";

await bot.api.call<ForumTopic>("createForumTopic", {
  chat_id: 123456789,
  name: "...",
} satisfies CreateForumTopicParams);

context shortcut

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

context shortcut

/** Use this method to create 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 right. Returns information about the created topic as a [ForumTopic](https://core.telegram.org/bots/api/#forumtopic) object. */
ctx.createForumTopic(params: Omit<CreateForumTopicParams, "chat_id">)

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