APIInvite | helly

Index

approximate_member_count?: number

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

approximate_presence_count?: number

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

channel: null | Required<APIPartialChannel>

The channel this invite is for

code: string

The invite code (unique ID)

expires_at?: null | string

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

The guild this invite is for

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

inviter?: APIUser

The user who created the invite

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

target_application?: Partial<APIApplication>

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

The type of target for this voice channel invite

target_user?: APIUser

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