MadelineProtoDocs/old_docs/API_docs_v17/methods/messages.toggleDialogPin.md

title	description	image	redirect_from
messages.toggleDialogPin	Pin/unpin a dialog	https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png	/API_docs/methods/messages_toggleDialogPin.html

Method: messages.toggleDialogPin

Back to methods index

Pin/unpin a dialog

Parameters:

Name	Type	Description	Required
pinned	Bool	Whether to pin or unpin the dialog	Optional
peer	Username, chat ID, Update, Message or InputPeer		Optional

Return type: Bool

Can bots use this method: NO

MadelineProto Example (now async for huge speed and parallelism!):

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' => InputPeer, ]);

Or, if you're into Lua:

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

Errors

Code	Type	Description
400	PEER_ID_INVALID	The provided peer id is invalid