Skip to main content
Module

x/discord_api_types/payloads/v8/invite.ts>APIInvite

Up to date Discord API Typings, versioned by the API version
discordjs/discord-api-types
Go to Latest
interface APIInvite
Deprecated
Deprecated

API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.

import { type APIInvite } from "https://deno.land/x/discord_api_types@0.37.11/payloads/v8/invite.ts";

https://discord.com/developers/docs/resources/invite#invite-object

Properties

code: string

The invite code (unique ID)

optional
guild: APIInviteGuild

The guild this invite is for

See https://discord.com/developers/docs/resources/guild#guild-object

channel: Required<APIPartialChannel> | null

The channel this invite is for

See https://discord.com/developers/docs/resources/channel#channel-object

optional
inviter: APIUser

The user who created the invite

See https://discord.com/developers/docs/resources/user#user-object

optional
target_type: InviteTargetType

The type of target for this voice channel invite

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

optional
target_user: APIUser

The user whose stream to display for this voice channel stream invite

See https://discord.com/developers/docs/resources/user#user-object

optional
target_application: Partial<APIApplication>

The embedded application to open for this voice channel embedded application invite

See https://discord.com/developers/docs/topics/oauth2#application

optional
approximate_presence_count: number

Approximate count of online members, returned from the GET /invites/<code> endpoint when with_counts is true

optional
approximate_member_count: number

Approximate count of total members, returned from the GET /invites/<code> endpoint when with_counts is true

optional
expires_at: string | null

The expiration date of this invite, returned from the GET /invites/<code> endpoint when with_expiration is true

optional
stage_instance: APIInviteStageInstance

The stage instance data if there is a public stage instance in the stage channel this invite is for

optional
guild_scheduled_event: APIGuildScheduledEvent

The guild scheduled event data, returned from the GET /invites/<code> endpoint when guild_scheduled_event_id is a valid guild scheduled event id