edit_message_checklist()

Client.edit_message_checklist()

Use this method to edit a checklist.

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``) – Unique identifier for the target message.

  • checklist (:obj:`~pyrogram.types.InputChecklist`) – New checklist.

  • reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup`, *optional*) – An InlineKeyboardMarkup object.

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

  • caption (``str``, *optional*) – Media caption, 0-1024 characters.

  • parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

  • caption_entities (List of :obj:`~pyrogram.types.MessageEntity`) – List of special entities that appear in the caption, which can be specified instead of parse_mode.

Returns:

:obj:`~pyrogram.types.Message` (On success, the edited message is returned.)

Example

# Replace the current checklist with a new one
await app.edit_message_checklist(
    chat_id=chat_id,
    message_id=message_id,
    checklist=types.InputChecklist(
        title="To Do",
        tasks=[
            types.InputChecklistTask(id=2, text="Task 2"),
            types.InputChecklistTask(id=3, text="Task 3"),
        ]
    )
)