unpinAllGeneralForumTopicMessages()

Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. 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 supergroup in the format `@username`

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

await bot.api.call<boolean>("unpinAllGeneralForumTopicMessages", {
  chat_id: 123456789,
} satisfies UnpinAllGeneralForumTopicMessagesParams);

context shortcut

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

context shortcut

/** Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the *can\_pin\_messages* administrator right in the supergroup. Returns *True* on success. */
ctx.unpinAllGeneralForumTopicMessages(params?: Omit<UnpinAllGeneralForumTopicMessagesParams, "chat_id">)

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