aiogram/.butcher/methods/editMessageText/entity.json

{
  "meta": {},
  "group": {
    "title": "Updating messages",
    "anchor": "updating-messages"
  },
  "object": {
    "anchor": "editmessagetext",
    "name": "editMessageText",
    "description": "Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.",
    "html_description": "<p>Use this method to edit text and <a href=\"#games\">game</a> messages. On success, if the edited message is not an inline message, the edited <a href=\"#message\">Message</a> is returned, otherwise <em>True</em> is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within <strong>48 hours</strong> from the time they were sent.</p>",
    "rst_description": "Use this method to edit text and `game <https://core.telegram.org/bots/api#games>`_ messages. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.",
    "annotations": [
      {
        "type": "String",
        "required": false,
        "description": "Unique identifier of the business connection on behalf of which the message to be edited was sent",
        "html_description": "<td>Unique identifier of the business connection on behalf of which the message to be edited was sent</td>",
        "rst_description": "Unique identifier of the business connection on behalf of which the message to be edited was sent\n",
        "name": "business_connection_id"
      },
      {
        "type": "Integer or String",
        "required": false,
        "description": "Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
        "html_description": "<td>Required if <em>inline_message_id</em> is not specified. Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
        "rst_description": "Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
        "name": "chat_id"
      },
      {
        "type": "Integer",
        "required": false,
        "description": "Required if inline_message_id is not specified. Identifier of the message to edit",
        "html_description": "<td>Required if <em>inline_message_id</em> is not specified. Identifier of the message to edit</td>",
        "rst_description": "Required if *inline_message_id* is not specified. Identifier of the message to edit\n",
        "name": "message_id"
      },
      {
        "type": "String",
        "required": false,
        "description": "Required if chat_id and message_id are not specified. Identifier of the inline message",
        "html_description": "<td>Required if <em>chat_id</em> and <em>message_id</em> are not specified. Identifier of the inline message</td>",
        "rst_description": "Required if *chat_id* and *message_id* are not specified. Identifier of the inline message\n",
        "name": "inline_message_id"
      },
      {
        "type": "String",
        "required": true,
        "description": "New text of the message, 1-4096 characters after entities parsing",
        "html_description": "<td>New text of the message, 1-4096 characters after entities parsing</td>",
        "rst_description": "New text of the message, 1-4096 characters after entities parsing\n",
        "name": "text"
      },
      {
        "type": "String",
        "required": false,
        "description": "Mode for parsing entities in the message text. See formatting options for more details.",
        "html_description": "<td>Mode for parsing entities in the message text. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
        "rst_description": "Mode for parsing entities in the message text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
        "name": "parse_mode"
      },
      {
        "type": "Array of MessageEntity",
        "required": false,
        "description": "A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode",
        "html_description": "<td>A JSON-serialized list of special entities that appear in message text, which can be specified instead of <em>parse_mode</em></td>",
        "rst_description": "A JSON-serialized list of special entities that appear in message text, which can be specified instead of *parse_mode*\n",
        "name": "entities"
      },
      {
        "type": "LinkPreviewOptions",
        "required": false,
        "description": "Link preview generation options for the message",
        "html_description": "<td>Link preview generation options for the message</td>",
        "rst_description": "Link preview generation options for the message\n",
        "name": "link_preview_options"
      },
      {
        "type": "InlineKeyboardMarkup",
        "required": false,
        "description": "A JSON-serialized object for an inline keyboard.",
        "html_description": "<td>A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>.</td>",
        "rst_description": "A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_.\n",
        "name": "reply_markup"
      },
      {
        "type": "Boolean",
        "required": false,
        "description": "Disables link previews for links in this message",
        "html_description": "<td>Disables link previews for links in this message</td>",
        "rst_description": "Disables link previews for links in this message\n",
        "name": "disable_web_page_preview",
        "deprecated": {
          "version": "7.0",
          "release_date": "2023-12-29"
        }
      }
    ],
    "category": "methods"
  }
}