setChatTitle()

Use this method to change the title of a chat. Titles can't be changed for private chats. 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`
`title`	string	required	New chat title, 1-128 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 { SetChatTitleParams } from "@yaebal/types";

await bot.api.call<boolean>("setChatTitle", {
  chat_id: 123456789,
  title: "...",
} satisfies SetChatTitleParams);

context shortcut

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

context shortcut

/** Use this method to change the title of a chat. Titles can't be changed for private chats. 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.setChatTitle(params: Omit<SetChatTitleParams, "chat_id">)

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