CreateChannelInvite
Documentation / @discordeno/types / CreateChannelInvite
Interface: CreateChannelInvite
Defined in: discordeno/channel.ts:288
https://docs.discord.com/developers/resources/channel#create-channel-invite-json-params
Properties
maxAge?
optionalmaxAge?:number
Defined in: discordeno/channel.ts:290
Duration of invite in seconds before expiry, or 0 for never. Between 0 and 604800 (7 days). Default: 86400 (24 hours)
maxUses?
optionalmaxUses?:number
Defined in: discordeno/channel.ts:292
Max number of users or 0 for unlimited. Between 0 and 100. Default: 0
roleIds?
optionalroleIds?:BigString[]
Defined in: discordeno/channel.ts:316
The role ID(s) for roles in the guild given to the users that accept this invite
Remarks
Requires the MANAGE_ROLES permission and cannot assign roles with higher permissions than the sender.
targetApplicationId?
optionaltargetApplicationId?:BigString
Defined in: discordeno/channel.ts:302
The id of the embedded application to open for this invite, required if target_type is 2, the application must have the EMBEDDED flag
targetType?
optionaltargetType?:TargetTypes
Defined in: discordeno/channel.ts:298
The type of target for this voice channel invite
targetUserId?
optionaltargetUserId?:BigString
Defined in: discordeno/channel.ts:300
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
targetUsersFile?
optionaltargetUsersFile?:Blob
Defined in: discordeno/channel.ts:309
A csv file with a single column of user IDs for all the users able to accept this invite
Remarks
Uploading a file with invalid user IDs will result in a 400 with the invalid IDs described.
temporary?
optionaltemporary?:boolean
Defined in: discordeno/channel.ts:294
Whether this invite only grants temporary membership. Default: false
unique?
optionalunique?:boolean
Defined in: discordeno/channel.ts:296
If true, don't try to reuse similar invite (useful for creating many unique one time use invites). Default: false