Skip to content

GramIO API Reference / gramio/dist / PinChatMessageParams

Interface: PinChatMessageParams

Defined in: @gramio/types/out/params.d.ts:2151

Params object for pinChatMessage method

Properties

PropertyTypeDescriptionDefined in
business_connection_id?stringUnique identifier of the business connection on behalf of which the message will be pinned@gramio/types/out/params.d.ts:2155
chat_idstring | numberUnique identifier for the target chat or username of the target channel (in the format @channelusername)@gramio/types/out/params.d.ts:2159
disable_notification?booleanPass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.@gramio/types/out/params.d.ts:2167
message_idnumberIdentifier of a message to pin@gramio/types/out/params.d.ts:2163