UpdateUsernameRequest

Only users can use this request. See code examples.

---functions---
channels.updateUsername#3514b3de channel:InputChannel username:string = Bool

Returns

Bool

This type has no instances available.

Parameters

channelInputChannelAnything entity-like will work if the library can find its Input version (e.g., usernames, Peer, User or Channel objects, etc.).
usernamestring

Known RPC errors

This request can cause 6 known errors:

ChannelsAdminPublicTooMuchErrorYou're admin of too many public channels, make some channels private to change the username of this channel.
ChannelInvalidErrorInvalid channel object. Make sure to pass the right types, for instance making sure that the request is designed for channels or otherwise look for a different one more suited.
ChatAdminRequiredErrorChat admin privileges are required to do that in the specified chat (for example, to send a message in a channel which is not yours), or invalid permissions used for the channel or group.
UsernameInvalidErrorNobody is using this username, or the username is unacceptable. If the latter, it must match r"[a-zA-Z][\w\d]{3,30}[a-zA-Z\d]".
UsernameOccupiedErrorThe username is already taken.
UsernamePurchaseAvailableError.

You can import these from telethon.errors.

Example

from telethon.sync import TelegramClient
from telethon import functions, types

with TelegramClient(name, api_id, api_hash) as client:
    result = client(functions.channels.UpdateUsernameRequest(
        channel='username',
        username='some string here'
    ))
    print(result)