UpdatePinnedMessageRequest

Both users and bots can use this request. See code examples.

---functions---
messages.updatePinnedMessage#d2aaf7ec flags:# silent:flags.0?true unpin:flags.1?true pm_oneside:flags.2?true peer:InputPeer id:int = Updates

Returns

Updates

This type can be an instance of either:

UpdateShort	UpdateShortChatMessage
UpdateShortMessage	UpdateShortSentMessage
Updates	UpdatesCombined
UpdatesTooLong

Parameters

peer	InputPeer	Anything entity-like will work if the library can find its `Input` version (e.g., usernames, `Peer`, `User` or `Channel` objects, etc.).
id	int
silent	flag	This argument defaults to `None` and can be omitted.
unpin	flag	This argument defaults to `None` and can be omitted.
pm_oneside	flag	This argument defaults to `None` and can be omitted.

Known RPC errors

This request can cause 1 known error:

BotOnesideNotAvailError Bots can't pin messages in PM just for themselves.

You can import these from telethon.errors.

Example

from telethon.sync import TelegramClient
from telethon import functions, types

with TelegramClient(name, api_id, api_hash) as client:
    result = client(functions.messages.UpdatePinnedMessageRequest(
        peer='username',
        id=42,
        unpin=True,
        pm_oneside=True
    ))
    print(result.stringify())