Preview environment

interface RESTPostAPIChannelInviteJSONBody

export interface RESTPostAPIChannelInviteJSONBody

See also: https://discord.com/developers/docs/resources/channel#create-channel-invite

optional
max_age? : number | undefined

Duration of invite in seconds before expiry, or 0 for never

optional
max_uses? : number | undefined

Max number of uses or 0 for unlimited

optional
target_application_id? : Snowflake | undefined

The id of the embedded application to open for this invite - Required if target_type is 2 - The application must have the EMBEDDED flag

optional
target_type? : InviteTargetType | undefined

The type of target for this voice channel invite

See also: https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types

optional
target_user_id? : Snowflake | undefined

The id of the user whose stream to display for this invite - Required if target_type is 1 - The user must be streaming in the channel

optional
temporary? : boolean | undefined

Whether this invite only grants temporary membership

optional
unique? : boolean | undefined

If true, don't try to reuse a similar invite (useful for creating many unique one time use invites)