Available methods

setMyShortDescription()

Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.

parameters

parametertyperequireddescription
short_descriptionstringoptionalNew short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.
language_codestringoptionalA two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short 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 { SetMyShortDescriptionParams } from "@yaebal/types";

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