GramIO API Reference / gramio/dist / CreateChatInviteLinkParams

Interface: CreateChatInviteLinkParams

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

Params object for createChatInviteLink method

Properties

Property	Type	Description	Defined in
chat_id	string | number	Unique identifier for the target chat or username of the target channel (in the format @channelusername)	@gramio/types/out/params.d.ts:1965
creates_join_request?	boolean	True, 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:1981
expire_date?	number	Point in time (Unix timestamp) when the link will expire	@gramio/types/out/params.d.ts:1973
member_limit?	number	The 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:1977
name?	string	Invite link name; 0-32 characters	@gramio/types/out/params.d.ts:1969