Skip to content

GramIO API Reference / gramio/dist / EditChatInviteLinkParams

Interface: EditChatInviteLinkParams

Defined in: @gramio/types/out/params.d.ts:1987

Params object for editChatInviteLink method

Properties

PropertyTypeDescriptionDefined in
chat_idstring | numberUnique identifier for the target chat or username of the target channel (in the format @channelusername)@gramio/types/out/params.d.ts:1991
creates_join_request?booleanTrue, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified@gramio/types/out/params.d.ts:2011
expire_date?numberPoint in time (Unix timestamp) when the link will expire@gramio/types/out/params.d.ts:2003
invite_linkstringThe invite link to edit@gramio/types/out/params.d.ts:1995
member_limit?numberThe maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999@gramio/types/out/params.d.ts:2007
name?stringInvite link name; 0-32 characters@gramio/types/out/params.d.ts:1999