MadelineProto/old_docs/API_docs_v45/methods/account_updateUsername.md
2017-12-11 12:12:38 +01:00

66 lines
1.4 KiB
Markdown

---
title: account.updateUsername
description: account.updateUsername parameters, return type and example
---
## Method: account.updateUsername
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|username|[string](../types/string.md) | Yes|
### Return type: [User](../types/User.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|USERNAME_INVALID|The provided username is not valid|
|USERNAME_NOT_MODIFIED|The username was not modified|
|USERNAME_OCCUPIED|The provided username is already occupied|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
$MadelineProto->session = 'mySession.madeline';
if (isset($number)) { // Login as a user
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
$MadelineProto->complete_phone_login($code);
}
$User = $MadelineProto->account->updateUsername(['username' => 'string', ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.updateUsername`
Parameters:
username - Json encoded string
Or, if you're into Lua:
```
User = account.updateUsername({username='string', })
```