GramJS

messages.ToggleDialogPin

Pin/unpin a dialog

Example

const { Api, TelegramClient } = require("telegram");
const { StringSession } = require("telegram/sessions");

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result = await client.invoke(
    new Api.messages.ToggleDialogPin({
      peer: "username",
      pinned: true,
    })
  );
  console.log(result); // prints the result
})();
import { Api, TelegramClient } from "telegram";
import { StringSession } from "telegram/sessions";

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result: Api.Bool = await client.invoke(
    new Api.messages.ToggleDialogPin({
      peer: "username",
      pinned: true,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
flags#Flags, see TL conditional fields
pinnedflags.0?trueWhether to pin or unpin the dialog
peerInputDialogPeerThe dialog to pin

Result

Bool

Possible errors

CodeTypeDescription
400PEER_ID_INVALIDThe provided peer id is invalid

Can bots use this method?

No