GramJS

channels.UpdateUsername

Change the username of a 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.channels.UpdateUsername({
      channel: "username",
      username: "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.channels.UpdateUsername({
      channel: "username",
      username: "some string here",
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
channelInputChannelChannel
usernamestringNew username

Result

Bool

Possible errors

CodeTypeDescription
400CHANNELS_ADMIN_PUBLIC_TOO_MUCHYou're admin of too many public channels, make some channels private to change the username of this channel
400CHANNEL_INVALIDThe provided channel is invalid
400CHANNEL_PRIVATEYou haven't joined this channel/supergroup
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
400USERNAME_INVALIDThe provided username is not valid
400USERNAME_NOT_MODIFIEDThe username was not modified
400USERNAME_OCCUPIEDThe provided username is already occupied

Can bots use this method?

No