edit_message_text()

Client.edit_message_text(chat_id: int | str, message_id: int, text: str | None = None, parse_mode: ParseMode | None = None, entities: List[MessageEntity] | None = None, link_preview_options: LinkPreviewOptions = None, schedule_date: datetime | None = None, business_connection_id: str | None = None, rich_message: InputRichMessage | None = None, reply_markup: InlineKeyboardMarkup = None, show_caption_above_media: bool | None = None, disable_web_page_preview: bool | None = None) → Message

Edit the text of messages.

Usable by ✅ Users ✅ Bots
Parameters:

  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).

  • message_id (int) – Message identifier in the chat specified in chat_id.

  • text (str, optional) – New text of the message. Required if rich_message isn’t specified.

  • parse_mode (ParseMode, optional) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

  • entities (List of MessageEntity, optional) – List of special entities that appear in message text, which can be specified instead of parse_mode.

  • link_preview_options (LinkPreviewOptions, optional) – Options used for link preview generation for the message.

  • schedule_date (datetime, optional) – Date when the message will be automatically sent.

  • business_connection_id (str, optional) – Unique identifier of the business connection on behalf of which the message will be sent.

  • rich_message (InputRichMessage, optional) – New rich content of the message. Required if text isn’t specified.

  • reply_markup (InlineKeyboardMarkup, optional) – An InlineKeyboardMarkup object.

Returns:

Message – On success, the edited message is returned.

Example

# Simple edit text
await app.edit_message_text(chat_id, message_id, "new text")

# Take the same text message, remove the web page preview only
from ftmgram import types

await app.edit_message_text(
    chat_id, message_id, message.text,
    link_preview_options=types.LinkPreviewOptions(is_disabled=True))