aiogram/docs/api/methods/set_chat_administrator_custom_title.md

61 lines
1.4 KiB
Markdown
Raw Normal View History

2020-01-11 22:59:14 +02:00
# setChatAdministratorCustomTitle
## Description
Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
## Arguments
| Name | Type | Description |
| - | - | - |
| `chat_id` | `#!python3 Union[int, str]` | Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) |
| `user_id` | `#!python3 int` | Unique identifier of the target user |
| `custom_title` | `#!python3 str` | New custom title for the administrator; 0-16 characters, emoji are not allowed |
## Response
Type: `#!python3 bool`
Description: Returns True on success.
## Usage
### As bot method bot
```python3
result: bool = await bot.set_chat_administrator_custom_title(...)
```
### Method as object
Imports:
- `from aiogram.methods import SetChatAdministratorCustomTitle`
- `from aiogram.api.methods import SetChatAdministratorCustomTitle`
- `from aiogram.api.methods.set_chat_administrator_custom_title import SetChatAdministratorCustomTitle`
#### In handlers with current bot
```python3
result: bool = await SetChatAdministratorCustomTitle(...)
```
#### With specific bot
```python3
result: bool = await bot(SetChatAdministratorCustomTitle(...))
```
#### As reply into Webhook in handler
```python3
return SetChatAdministratorCustomTitle(...)
```
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#setchatadministratorcustomtitle)