MadelineProtoDocs/old_docs/API_docs_v89/methods/account_updateUsername.md

56 lines
1.3 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2018-12-26 02:56:50 +01:00
title: account.updateUsername
description: Update this user's username
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: account.updateUsername
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2018-12-26 02:56:50 +01:00
Update this user's username
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
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
### Return type: [User](../types/User.md)
### Can bots use this method: **NO**
### MadelineProto Example:
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
2019-03-12 13:25:41 +01:00
define('MADELINE_BRANCH', '');
2018-04-01 13:19:25 +02:00
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2018-12-26 02:56:50 +01:00
$User = $MadelineProto->account->updateUsername(['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
User = account.updateUsername({username='string', })
2018-04-01 13:19:25 +02:00
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
2018-12-26 02:56:50 +01:00
|USERNAME_INVALID|The provided username is not valid|
|USERNAME_NOT_MODIFIED|The username was not modified|
|USERNAME_OCCUPIED|The provided username is already occupied|
|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login|
2018-04-01 13:19:25 +02:00