edit_message_text()

Client.edit_message_text()

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) – New text of the message.

• 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) – List of special entities that appear in message text, which can be specified instead of parse_mode.

• link_preview_options (LinkPreviewOptions, optional) – Link preview generation options for the message. Ignored if the specified URL does not have a valid preview.

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

• 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 to be edited was sent

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
await app.edit_message_text(
    chat_id, message_id, message.text,
    link_preview_options=types.LinkPreviewOptions(
        is_disabled=True
    )
)