Available methods

setMyDescription()

Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.

parameters

parametertyperequireddescription
descriptionstringoptionalNew bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.
language_codestringoptionalA two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.

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

await bot.api.call<boolean>("setMyDescription", {} satisfies SetMyDescriptionParams);