Skip to main content
Module

x/grammy/mod.ts>Api#pinChatMessage

The Telegram Bot Framework.
grammyjs/grammY
Extremely Popular
Go to Latest
method Api.prototype.pinChatMessage
import { Api } from "https://deno.land/x/grammy@v1.11.1/mod.ts";

Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.

Parameters

chat_id: number | string

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

message_id: number

Identifier of a message to pin

optional
other: Other<R, "pinChatMessage", "chat_id" | "message_id">

Optional remaining parameters, confer the official reference below

optional
signal: AbortSignal

Optional AbortSignal to cancel the request

Official reference: https://core.telegram.org/bots/api#pinchatmessage