Sends an invite to an Xbox user with the given connection string.
This API allows a game server to send an invite to an Xbox Live user. The body of the request contains a connection string that is used by the invitee to join the server. The connection string could contain the game server IP or a pointer to a session that the user is in. The invite is sent to all registered endpoints, regardless of platform.
POST /titles/{titleId}/invites/server
URI parameters
Parameter
In
Required
Type
Description
titleId
path
TRUE
integer
The titleId of the game that the request is being sent for.
Request header
Name
Required
Type
Description
Authorization
TRUE
integer
Caller must supply an XToken in the XBL 3.0 authorization format. For example, Authorization: XBL3.0 x=2553948354698;>encrypted token<)
Content-Type
TRUE
string
ContentType must be set to application/json
Request body
Name
Required
Type
Description
invitedUsers
TRUE
string[]
The XUID of the users the invite is being sent to. The XUID is represented as a base 10 integer. The maximum is 16 XUIDs.
sender
TRUE
string
The id of the user on whose behalf the invite is being sent.
connectionString
string
The connection string is what gets passed to the game when the invite reaches the user. The connection string usually contains information like the server IP to enable the invited user to join. If the connection string field is left empty then the title is invoked with an empty connection string. The length of the connection string is restricted to 512 characters.
An error occurred while processing the request. Possible error codes: "RequestValidationError: The request validation has failed.", " AuthorizationError: The caller is not allowed to access the resource. Too many requests."
Human readable version of the error message that can be used for debugging.
errorCode
string
Error code enum.
Platform
Name
Type
Description
Android
string
IOS
string
Nintendo
string
PlayStation
string
Scarlett
string
Win32
string
WindowsOneCore
string
XboxOne
string
SendServerInviteRequest
Name
Type
Description
connectionString
string
The connection string is what gets passed to the game when the invite reaches the user. The connection string usually contains information like the server IP to enable the invited user to join. If the connection string field is left empty then the title is invoked with an empty connection string. The length of the connection string is restricted to 512 characters.
invitedUsers
string[]
The XUID of the users the invite is being sent to. The XUID is represented as a base 10 integer. The maximum is 16 XUIDs.