MadelineProtoDocs/old_docs/API_docs_v82/methods/channels_updateUsername.md

60 lines
1.9 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2018-12-26 02:56:50 +01:00
title: channels.updateUsername
description: Update the username of a supergroup/channel
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-12-26 02:56:50 +01:00
# Method: channels.updateUsername
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2018-12-26 02:56:50 +01:00
Update the username of a supergroup/channel
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
2018-12-26 02:56:50 +01:00
|username|[string](../types/string.md) | The new username | Yes|
2018-04-01 13:19:25 +02:00
2018-12-26 02:56:50 +01:00
### Return type: [Bool](../types/Bool.md)
2018-04-01 13:19:25 +02:00
2018-12-26 02:56:50 +01:00
### Can bots use this method: **NO**
2018-04-01 13:19:25 +02:00
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2018-12-26 02:56:50 +01:00
$Bool = $MadelineProto->channels->updateUsername(['channel' => InputChannel, 'username' => 'string', ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2018-12-26 02:56:50 +01:00
Bool = channels.updateUsername({channel=InputChannel, username='string', })
2018-04-01 13:19:25 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|CHANNEL_INVALID|The provided channel is invalid|
2019-09-13 17:13:55 +02:00
|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
2019-09-02 17:41:28 +02:00
|400|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel|
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|400|USERNAME_INVALID|The provided username is not valid|
2019-09-13 17:13:55 +02:00
|400|USERNAME_NOT_MODIFIED|The username was not modified|
2019-09-02 17:41:28 +02:00
|400|USERNAME_OCCUPIED|The provided username is already occupied|
2019-09-13 17:13:55 +02:00
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
2018-04-01 13:19:25 +02:00