Max icon

Max

Interact with Max messenger

Actions11

Message → Pin Message

AI-generated

Summary

Pin a specific message in a group chat identified by its Chat ID and Message ID, optionally notifying chat members about the pinned message.

Inputs

  • Chat ID (required) — The identifier of the group chat where the message will be pinned. Pinning works only in group chats.
  • Message ID (required) — The identifier of the message to pin in the specified group chat.
  • Notify Members — Boolean flag indicating whether to notify members in the chat about the pinned message. Defaults to true.

Output shape

a JSON object containing the result of the pin operation, typically confirming success and echoing the chat and message IDs.

The operation requires valid numeric Chat ID and non-empty Message ID strings. It returns a success response structure or throws an error if the pinning fails.

Examples

Example 1: Pin a message in a group chat without notifying members

Set Chat ID and Message ID to identify the message to be pinned. Set Notify Members to false.

Example 2: Pin a message with member notification

Set Chat ID and Message ID with Notify Members as true (default) to inform chat participants of the pinned message.

Links

Discussion