MadelineProtoDocs/docs/API_docs/methods/account.updateUsername.md

57 lines
1.7 KiB
Markdown
Raw Normal View History

2019-06-23 13:07:51 +02:00
---
title: account.updateUsername
2019-12-27 17:48:04 +01:00
description: Changes username for the current user.
2019-06-23 13:07:51 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/account_updateUsername.html
2019-06-23 13:07:51 +02:00
---
# Method: account.updateUsername
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Changes username for the current user.
2019-06-23 13:07:51 +02:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:58:34 +01:00
|username|[string](../types/string.md) | Username or empty string if username is to be removed<br>Accepted characters: a-z (case-insensitive), 0-9 and underscores.<br>Length: 5-32 characters. | Yes|
2019-06-23 13:07:51 +02:00
### Return type: [User](../types/User.md)
### Can bots use this method: **NO**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
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();
$User = $MadelineProto->account->updateUsername(['username' => 'string', ]);
```
Or, if you're into Lua:
```lua
User = account.updateUsername({username='string', })
```
2019-09-02 17:41:28 +02:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|USERNAME_INVALID|The provided username is not valid|
|400|USERNAME_NOT_MODIFIED|The username was not modified|
|400|USERNAME_OCCUPIED|The provided username is already occupied|
2020-02-23 19:29:04 +01:00
|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.|
2019-09-02 17:41:28 +02:00
|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login|
2019-06-23 13:07:51 +02:00