Method: messages.toggleDialogPin

Back to methods index

Pin or unpin dialog

Parameters:

Name Type Description Required
pinned Bool Pin or unpin the dialog? Optional
peer Username, chat ID, Update, Message or InputDialogPeer The dialog to pin Yes

Return type: Bool

Can bots use this method: NO

MadelineProto Example:

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();

$Bool = $MadelineProto->messages->toggleDialogPin(['pinned' => Bool, 'peer' => InputDialogPeer, ]);

PWRTelegram HTTP API example (NOT FOR MadelineProto):

As a user:

POST/GET to https://api.pwrtelegram.xyz/userTOKEN/messages.toggleDialogPin

Parameters:

pinned - Json encoded Bool

peer - Json encoded InputDialogPeer

Or, if you’re into Lua:

Bool = messages.toggleDialogPin({pinned=Bool, peer=InputDialogPeer, })

Errors this method can return:

Error Description
PEER_ID_INVALID The provided peer id is invalid