58 lines
1.7 KiB
Markdown
58 lines
1.7 KiB
Markdown
---
|
|
title: messages.updatePinnedMessage
|
|
description: Pin a message
|
|
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|
redirect_from: /API_docs/methods/messages_updatePinnedMessage.html
|
|
---
|
|
# Method: messages.updatePinnedMessage
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
Pin a message
|
|
|
|
### Parameters:
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|---------------|-------------|----------|
|
|
|silent|[Bool](../types/Bool.md) | Pin the message silently, without triggering a notification | Optional|
|
|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer where to pin the message | Optional|
|
|
|id|[int](../types/int.md) | The message to pin, can be 0 to unpin any currently pinned messages | Yes|
|
|
|
|
|
|
### Return type: [Updates](../types/Updates.md)
|
|
|
|
### Can bots use this method: **YES**
|
|
|
|
|
|
### 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();
|
|
|
|
$Updates = $MadelineProto->messages->updatePinnedMessage(['silent' => Bool, 'peer' => InputPeer, 'id' => int, ]);
|
|
```
|
|
|
|
Or, if you're into Lua:
|
|
|
|
```lua
|
|
Updates = messages.updatePinnedMessage({silent=Bool, peer=InputPeer, id=int, })
|
|
```
|
|
|
|
### Errors
|
|
|
|
| Code | Type | Description |
|
|
|------|----------|---------------|
|
|
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|
|
|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified|
|
|
|400|MESSAGE_ID_INVALID|The provided message id is invalid|
|
|
|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
|
|
|
|
|