Skip to main content

​
Invite Resource

Invites are unique codes that allow users to join guilds or group DMs.

​
Invite Object

​
Structure

​
code
string
required
Unique invite code (6-10 characters)
​
type
integer
required
Invite type (see Invite Types)
​
guild
Guild object | null
Partial guild object (for guild invites)
​
guild_id
Snowflake | null
ID of the guild
​
channel
Channel object | null
Partial channel object
​
channel_id
Snowflake | null
ID of the channel
​
inviter
User object | null
User who created the invite
​
inviter_id
Snowflake | null
ID of the inviter
​
created_at
ISO8601 timestamp
required
When the invite was created
​
expires_at
ISO8601 timestamp | null
When the invite expires (null if no expiration)
​
uses
integer
default:"0"
Number of times the invite has been used
​
max_uses
integer
default:"0"
Maximum number of uses (0 = unlimited)
​
max_age
integer
default:"0"
Duration in seconds before expiration (0 = never)
​
temporary
boolean
default:"false"
Whether the invite grants temporary membership
​
approximate_member_count
integer
Approximate number of members in the guild
​
approximate_presence_count
integer
Approximate number of online members
​
version
integer
required
Version for optimistic concurrency control

​
Example Invite

{
  "code": "abc123xyz",
  "type": 0,
  "guild": {
    "id": "987654321098765432",
    "name": "Fluxer Community",
    "icon_hash": "a1b2c3d4e5f6",
    "banner_hash": "b2c3d4e5f6a7",
    "splash_hash": null,
    "features": ["VANITY_URL", "BANNER"]
  },
  "guild_id": "987654321098765432",
  "channel": {
    "id": "444555666777888999",
    "name": "general",
    "type": 0
  },
  "channel_id": "444555666777888999",
  "inviter": {
    "id": "123456789012345678",
    "username": "fluxeruser",
    "discriminator": 1234,
    "avatar_hash": "a1b2c3d4e5f6"
  },
  "inviter_id": "123456789012345678",
  "created_at": "2026-03-01T10:00:00.000Z",
  "expires_at": null,
  "uses": 42,
  "max_uses": 0,
  "max_age": 0,
  "temporary": false,
  "approximate_member_count": 12450,
  "approximate_presence_count": 3890,
  "version": 1
}

​
Invite Types

​
Invite Metadata

When retrieving invites you created, additional metadata is returned:
​
uses
integer
Number of times used
​
max_uses
integer
Maximum number of uses
​
max_age
integer
Seconds until expiration
​
temporary
boolean
Grants temporary membership
​
created_at
ISO8601 timestamp
Creation timestamp

​
Vanity URL Invites

Guilds with the VANITY_URL feature can set a custom invite code: 
https://fluxer.chat/invite/fluxer
Vanity URLs:
  • Never expire
  • Have unlimited uses
  • Can only be changed by guild admins
  • Must be unique across all of Fluxer

​
Endpoints

​
Get Invite

GET /api/v1/invites/{invite_code}
Retrieve invite information.
​
with_counts
boolean
default:"false"
Include approximate member counts
​
with_expiration
boolean
default:"false"
Include expiration timestamp

​
Accept Invite

POST /api/v1/invites/{invite_code}
Accept an invite and join the guild or group DM.

​
Delete Invite

DELETE /api/v1/invites/{invite_code}
Revoke an invite. Requires MANAGE_CHANNELS permission or invite ownership.

​
Get Channel Invites

GET /api/v1/channels/{channel_id}/invites
Returns all active invites for a channel. Requires MANAGE_CHANNELS permission.

​
Create Channel Invite

POST /api/v1/channels/{channel_id}/invites
Create a new invite for the channel. Requires CREATE_INSTANT_INVITE permission.
​
max_age
integer
default:"86400"
Duration in seconds before expiration (0-604800, 0 = never)
​
max_uses
integer
default:"0"
Maximum number of uses (0-100, 0 = unlimited)
​
temporary
boolean
default:"false"
Grant temporary membership (kicked on disconnect)
​
unique
boolean
default:"true"
Create a unique code or reuse existing with same settings

​
Get Guild Invites

GET /api/v1/guilds/{guild_id}/invites
Returns all active invites for the guild. Requires MANAGE_GUILD permission.

​
Get Guild Vanity URL

GET /api/v1/guilds/{guild_id}/vanity-url
Get the guild’s vanity URL code and usage.

​
Update Guild Vanity URL

PATCH /api/v1/guilds/{guild_id}/vanity-url
Update the guild’s vanity URL. Requires MANAGE_GUILD permission and VANITY_URL feature.
​
code
string
required
New vanity code (3-32 characters, alphanumeric + hyphens)
Invite codes can be shared as URLs: 
https://fluxer.chat/invite/abc123xyz
https://fluxer.chat/abc123xyz
Both formats are valid and will resolve to the same invite.

Build docs developers (and LLMs) love

Get started for freeTalk to us