Contents Menu Expand Light mode Dark mode Auto light/dark mode
aiogram 3.0.0b8 documentation
Logo
aiogram 3.0.0b8 documentation
  • Installation
  • Bot API
    • Bot
    • Client session
      • Use Custom API server
      • Base
      • aiohttp
    • Types
      • ChosenInlineResult
      • InlineQuery
      • InlineQueryResult
      • InlineQueryResultArticle
      • InlineQueryResultAudio
      • InlineQueryResultCachedAudio
      • InlineQueryResultCachedDocument
      • InlineQueryResultCachedGif
      • InlineQueryResultCachedMpeg4Gif
      • InlineQueryResultCachedPhoto
      • InlineQueryResultCachedSticker
      • InlineQueryResultCachedVideo
      • InlineQueryResultCachedVoice
      • InlineQueryResultContact
      • InlineQueryResultDocument
      • InlineQueryResultGame
      • InlineQueryResultGif
      • InlineQueryResultLocation
      • InlineQueryResultMpeg4Gif
      • InlineQueryResultPhoto
      • InlineQueryResultVenue
      • InlineQueryResultVideo
      • InlineQueryResultVoice
      • InputContactMessageContent
      • InputInvoiceMessageContent
      • InputLocationMessageContent
      • InputMessageContent
      • InputTextMessageContent
      • InputVenueMessageContent
      • SentWebAppMessage
      • Animation
      • Audio
      • BotCommand
      • BotCommandScope
      • BotCommandScopeAllChatAdministrators
      • BotCommandScopeAllGroupChats
      • BotCommandScopeAllPrivateChats
      • BotCommandScopeChat
      • BotCommandScopeChatAdministrators
      • BotCommandScopeChatMember
      • BotCommandScopeDefault
      • BotDescription
      • BotShortDescription
      • CallbackQuery
      • Chat
      • ChatAdministratorRights
      • ChatInviteLink
      • ChatJoinRequest
      • ChatLocation
      • ChatMember
      • ChatMemberAdministrator
      • ChatMemberBanned
      • ChatMemberLeft
      • ChatMemberMember
      • ChatMemberOwner
      • ChatMemberRestricted
      • ChatMemberUpdated
      • ChatPermissions
      • ChatPhoto
      • ChatShared
      • Contact
      • Dice
      • Document
      • File
      • ForceReply
      • ForumTopic
      • ForumTopicClosed
      • ForumTopicCreated
      • ForumTopicEdited
      • ForumTopicReopened
      • GeneralForumTopicHidden
      • GeneralForumTopicUnhidden
      • InlineKeyboardButton
      • InlineKeyboardMarkup
      • InputFile
      • InputMedia
      • InputMediaAnimation
      • InputMediaAudio
      • InputMediaDocument
      • InputMediaPhoto
      • InputMediaVideo
      • KeyboardButton
      • KeyboardButtonPollType
      • KeyboardButtonRequestChat
      • KeyboardButtonRequestUser
      • Location
      • LoginUrl
      • MenuButton
      • MenuButtonCommands
      • MenuButtonDefault
      • MenuButtonWebApp
      • Message
      • MessageAutoDeleteTimerChanged
      • MessageEntity
      • MessageId
      • PhotoSize
      • Poll
      • PollAnswer
      • PollOption
      • ProximityAlertTriggered
      • ReplyKeyboardMarkup
      • ReplyKeyboardRemove
      • ResponseParameters
      • User
      • UserProfilePhotos
      • UserShared
      • Venue
      • Video
      • VideoChatEnded
      • VideoChatParticipantsInvited
      • VideoChatScheduled
      • VideoChatStarted
      • VideoNote
      • Voice
      • WebAppData
      • WebAppInfo
      • WriteAccessAllowed
      • EncryptedCredentials
      • EncryptedPassportElement
      • PassportData
      • PassportElementError
      • PassportElementErrorDataField
      • PassportElementErrorFile
      • PassportElementErrorFiles
      • PassportElementErrorFrontSide
      • PassportElementErrorReverseSide
      • PassportElementErrorSelfie
      • PassportElementErrorTranslationFile
      • PassportElementErrorTranslationFiles
      • PassportElementErrorUnspecified
      • PassportFile
      • Update
      • WebhookInfo
      • InputSticker
      • MaskPosition
      • Sticker
      • StickerSet
      • Invoice
      • LabeledPrice
      • OrderInfo
      • PreCheckoutQuery
      • ShippingAddress
      • ShippingOption
      • ShippingQuery
      • SuccessfulPayment
      • CallbackGame
      • Game
      • GameHighScore
    • Methods
      • answerCallbackQuery
      • approveChatJoinRequest
      • banChatMember
      • banChatSenderChat
      • close
      • closeForumTopic
      • closeGeneralForumTopic
      • copyMessage
      • createChatInviteLink
      • createForumTopic
      • declineChatJoinRequest
      • deleteChatPhoto
      • deleteChatStickerSet
      • deleteForumTopic
      • deleteMyCommands
      • editChatInviteLink
      • editForumTopic
      • editGeneralForumTopic
      • exportChatInviteLink
      • forwardMessage
      • getChat
      • getChatAdministrators
      • getChatMember
      • getChatMemberCount
      • getChatMenuButton
      • getFile
      • getForumTopicIconStickers
      • getMe
      • getMyCommands
      • getMyDefaultAdministratorRights
      • getMyDescription
      • getMyShortDescription
      • getUserProfilePhotos
      • hideGeneralForumTopic
      • leaveChat
      • logOut
      • pinChatMessage
      • promoteChatMember
      • reopenForumTopic
      • reopenGeneralForumTopic
      • restrictChatMember
      • revokeChatInviteLink
      • sendAnimation
      • sendAudio
      • sendChatAction
      • sendContact
      • sendDice
      • sendDocument
      • sendLocation
      • sendMediaGroup
      • sendMessage
      • sendPhoto
      • sendPoll
      • sendVenue
      • sendVideo
      • sendVideoNote
      • sendVoice
      • setChatAdministratorCustomTitle
      • setChatDescription
      • setChatMenuButton
      • setChatPermissions
      • setChatPhoto
      • setChatStickerSet
      • setChatTitle
      • setMyCommands
      • setMyDefaultAdministratorRights
      • setMyDescription
      • setMyShortDescription
      • unbanChatMember
      • unbanChatSenderChat
      • unhideGeneralForumTopic
      • unpinAllChatMessages
      • unpinAllForumTopicMessages
      • unpinChatMessage
      • answerPreCheckoutQuery
      • answerShippingQuery
      • createInvoiceLink
      • sendInvoice
      • addStickerToSet
      • createNewStickerSet
      • deleteStickerFromSet
      • deleteStickerSet
      • getCustomEmojiStickers
      • getStickerSet
      • sendSticker
      • setCustomEmojiStickerSetThumbnail
      • setStickerEmojiList
      • setStickerKeywords
      • setStickerMaskPosition
      • setStickerPositionInSet
      • setStickerSetThumbnail
      • setStickerSetTitle
      • uploadStickerFile
      • getGameHighScores
      • sendGame
      • setGameScore
      • deleteWebhook
      • getUpdates
      • getWebhookInfo
      • setWebhook
      • setPassportDataErrors
      • deleteMessage
      • editMessageCaption
      • editMessageLiveLocation
      • editMessageMedia
      • editMessageReplyMarkup
      • editMessageText
      • stopMessageLiveLocation
      • stopPoll
      • answerInlineQuery
      • answerWebAppQuery
    • Enums
      • BotCommandScopeType
      • ChatAction
      • ChatMemberStatus
      • ChatType
      • ContentType
      • DiceEmoji
      • InlineQueryResultType
      • InputMediaType
      • MaskPositionPoint
      • MenuButtonType
      • MessageEntityType
      • ParseMode
      • PollType
      • StickerFormat
      • StickerType
      • TopicIconColor
      • UpdateType
    • How to download file?
    • How to upload file?
  • Handling events
    • Observer
    • Router
    • Dispatcher
    • Class based handlers
      • BaseHandler
      • CallbackQueryHandler
      • ChosenInlineResultHandler
      • ErrorHandler
      • InlineQueryHandler
      • MessageHandler
      • PollHandler
      • PreCheckoutQueryHandler
      • ShippingQueryHandler
      • ChatMemberHandler
    • Filtering events
      • Command
      • Text
      • ChatMemberUpdated
      • Magic filters
      • MagicData
      • Callback Data Factory & Filter
      • Exceptions
    • Middlewares
    • Finite State Machine
      • Storages
    • Flags
  • Utils
    • Keyboard builder
    • Translation
    • Chat action sender
    • WebApp
    • Callback answer
  • Changelog
  • Contributing
  v: dev-3.x
Versions
latest
dev-3.x
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Back to top
Edit this page

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()

Next
editForumTopic
Previous
deleteMyCommands
Copyright © 2023, aiogram Team
Made with Sphinx and @pradyunsg's Furo
On this page
  • editChatInviteLink
    • EditChatInviteLink
      • EditChatInviteLink.chat_id
      • EditChatInviteLink.invite_link
      • EditChatInviteLink.name
      • EditChatInviteLink.expire_date
      • EditChatInviteLink.member_limit
      • EditChatInviteLink.creates_join_request
    • Usage
      • As bot method
      • Method as object
        • With specific bot
        • As reply into Webhook in handler
      • As shortcut from received object