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) – Message identifier in the chat specified in chat_id.

  • checklist (InputChecklist) – New checklist.

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

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

Returns:

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="Checklist",
        tasks=[
            types.InputChecklistTask(id=1, text="Task 1"),
            types.InputChecklistTask(id=2, text="Task 2")
        ]
    )
)