Available methods

deleteChatPhoto()

Use this method to delete a chat photo. Photos 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

parametertyperequireddescription
chat_idnumber | stringrequiredUnique identifier for the target chat or username of the target channel in the format @username

returns

boolean

usage in yaebal

deleteChatPhoto is directly typed on Api — call it straight off bot.api.

bot.ts
import type { DeleteChatPhotoParams } from "@yaebal/types";

await bot.api.deleteChatPhoto({
  chat_id: 123456789,
} satisfies DeleteChatPhotoParams);

context shortcut

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

context shortcut
/** Use this method to delete a chat photo. Photos 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.deleteChatPhoto(params?: Omit<DeleteChatPhotoParams, "chat_id">)