Interface ToggleChatIsPinned

Changes the pinned state of a chat. There can be up to getOption("pinned_chat_count_max")/getOption("pinned_archived_chat_count_max") pinned non-secret chats and the same number of secret chats in the main/archive chat list. The limit can be increased with Telegram Premium. Request type for Tdjson#toggleChatIsPinned.

interface ToggleChatIsPinned {
    @type: "toggleChatIsPinned";
    chat_id: number;
    chat_list: ChatList;
    is_pinned?: boolean;
}

Properties

@type: "toggleChatIsPinned"
chat_id: number

Chat identifier.

chat_list: ChatList

Chat list in which to change the pinned state of the chat.

is_pinned?: boolean

Pass true to pin the chat; pass false to unpin it.