editChatInviteLink#

Returns: ChatInviteLink

class aiogram.methods.edit_chat_invite_link.EditChatInviteLink(*, chat_id: Union[int, str], invite_link: str, name: Optional[str] = None, expire_date: Optional[Union[datetime, timedelta, int]] = None, member_limit: Optional[int] = None, creates_join_request: Optional[bool] = None, **extra_data: Any)[source]#

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a aiogram.types.chat_invite_link.ChatInviteLink object.

Source: https://core.telegram.org/bots/api#editchatinvitelink

chat_id: Union[int, str]#: Unique identifier for the target chat or username of the target channel (in the format @channelusername)

invite_link: str#: The invite link to edit

name: Optional[str]#: Invite link name; 0-32 characters

expire_date: Optional[Union[datetime, timedelta, int]]#: Point in time (Unix timestamp) when the link will expire

member_limit: Optional[int]#: The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999

creates_join_request: Optional[bool]#: True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can’t be specified

Usage#

As bot method#

result: ChatInviteLink = await bot.edit_chat_invite_link(...)

Method as object#

Imports:

from aiogram.methods.edit_chat_invite_link import EditChatInviteLink
alias: from aiogram.methods import EditChatInviteLink

With specific bot#

result: ChatInviteLink = await bot(EditChatInviteLink(...))

As reply into Webhook in handler#

return EditChatInviteLink(...)

As shortcut from received object#

aiogram.types.chat.Chat.edit_invite_link()