GramJS

messages.EditChatAbout

Edit the description of a group/supergroup/channel.

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.EditChatAbout({
      peer: "username",
      about: "some string here",
    })
  );
  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.EditChatAbout({
      peer: "username",
      about: "some string here",
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
peerInputPeerThe group/supergroup/channel.
aboutstringThe new description

Result

Bool

Possible errors

CodeTypeDescription
400CHANNEL_INVALIDThe provided channel is invalid
400CHANNEL_PRIVATEYou haven't joined this channel/supergroup
400CHAT_ABOUT_NOT_MODIFIEDAbout text has not changed
400CHAT_ABOUT_TOO_LONGChat about too long
400CHAT_ADMIN_REQUIREDYou must be an admin in this chat to do this
400CHAT_NOT_MODIFIEDThe pinned message wasn't modified
403CHAT_WRITE_FORBIDDENYou can't write in this chat
400PEER_ID_INVALIDThe provided peer id is invalid

Can bots use this method?

Yes

Channels

How to handle channels, supergroups, groups, and what's the difference between them.