Game Invites

Game invites allow users to invite their friends to play from their console.

Game Invite Object

Game Invite Structure

Field	Type	Description
invite_id	snowflake	The ID of the game invite
created_at	ISO8601 timestamp	When the game invite was created
ttl	integer	Duration in seconds after which the game invite expires
inviter_id	snowflake	The ID of the user who created the game invite
recipient_id	snowflake	The ID of the user who received the game invite
platform_type	string	The type of the platform the game invite was created on
launch_parameters	string	The parameters for launching the game, generally encoded as a JSON string
installed?	boolean	Whether the game is installed (default false)
joinable?	boolean	Whether the game is joinable (default false)
fallback_url	?string	The URL for installing the game
application_asset	string	The URL of the game icon
application_name	string	The name of the game

Example Game Invite

{
  "invite_id": "1387169389857607774",
  "created_at": "2025-06-24T20:35:54.903000+00:00",
  "ttl": 900,
  "inviter_id": "1001086404203389018",
  "recipient_id": "852892297661906993",
  "platform_type": "xbox",
  "launch_parameters": "{\"titleId\":1750797354,\"inviteToken\":\"3bFFu5mTMiitj8cp8n1rbio1F850A8eE\"}",
  "fallback_url": null,
  "application_asset": "https://images-ext-1.discordapp.net/external/GyQicPLz_zQO15bOMtiGTtC4Kud7JjQbs1Ecuz7RrtU/https/cdn.discordapp.com/app-icons/356875570916753438/166fbad351ecdd02d11a3b464748f66b.png",
  "application_name": "Minecraft"
}

Game Launch Parameters

Field	Type	Description
titleId?	?integer	The ID of the title
inviteToken?	?string	The token of the game invite

Endpoints

Create Game Invite

POST/game-invite/@me

Creates a game invite. Fires a Game Invite Create Gateway event.

JSON Params

Field	Type	Description
recipient_id	snowflake	The ID of the recipient to send game invite to
launch_parameters	string	The parameters for launching the game, generally encoded as a JSON string (max 8192 characters)
application_asset	string	The URL of the game icon
application_name	string	The name of the game (2-128 characters)
fallback_url?	?string	The URL for installing the game
ttl?	?integer	Duration in seconds after which the game invite expires (300-86400, default 900)

Response Body

Field	Type	Description
invite_id	snowflake	The ID of the created game invite

Delete Game Invite

DELETE/game-invite/@me/{game_invite.invite_id}

Deletes a game invite. Returns a 204 empty response on success. Fires a Game Invite Delete Gateway event.

Delete Game Invites

DELETE/game-invite/@me

Deletes all game invites for the current user. Returns a 204 empty response on success. Fires a Game Invite Delete Many Gateway event.