botapi

Use this method to add a message to the list of pinned messages in a chat

POST /pinChatMessage

Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.

Body Required

  • chat_id integer | string Required

    Any of:
    integer-1 integer string-2 string

    Unique identifier for the target chat or username of the target channel (in the format @channelusername)

    Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • message_id integer Required

    Identifier of a message to pin

  • disable_notification boolean

    Pass 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.

Responses

  • default
    Hide response attributes Show response attributes object
    • ok boolean Required

      Default value is false.

    • error_code integer Required
    • description string Required
    • parameters object

      Contains information about why a request was unsuccessful.

      Hide parameters attributes Show parameters attributes object
      • migrate_to_chat_id integer

        Optional. The group has been migrated to a supergroup with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.

      • retry_after integer

        Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated
  • 200
    Hide response attributes Show response attributes object
    • ok boolean Required

      Default value is true.

    • result boolean Required

      Default value is true.
POST /pinChatMessage 
curl \
 -X POST https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/pinChatMessage \
 -H "Content-Type: application/json" \
 -d '{"chat_id":42,"message_id":42,"disable_notification":true}'
Request example 
{
  "chat_id": 42,
  "message_id": 42,
  "disable_notification": true
}
Request examples 
{
  "chat_id": 42,
  "message_id": 42,
  "disable_notification": true
}
Response examples (default) 
{
  "ok": false,
  "error_code": 42,
  "description": "string",
  "parameters": {
    "migrate_to_chat_id": 42,
    "retry_after": 42
  }
}
Response examples (default) 
{
  "ok": false,
  "error_code": 42,
  "description": "string",
  "parameters": {
    "migrate_to_chat_id": 42,
    "retry_after": 42
  }
}
Response examples (200) 
{
  "ok": true,
  "result": true
}
Response examples (200) 
{
  "ok": true,
  "result": true
}