Sign in
session

Invite user to party

Sends a party invitation to another Xbox Live user.

Parameters

  • sessionId (path) - The service config ID (SCID), typically 7492BACA-C1B4-440D-A391-B7EF364A8D40
  • xuid (body) - The Xbox User ID of the person to invite
  • sessionName (body) - The unique session name from /session/create

How Invitations Work

  1. The invited user receives a notification on their Xbox device
  2. They can accept to join the party
  3. Once accepted, they appear in the session's member list

Example Request

{
  "xuid": "2533274817903789",
  "sessionName": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Requirements

  • You must be a member of the session to invite others
  • The invited user must have their privacy settings configured to receive invites
post/v2/session/invite/{sessionId}

Path parameters

sessionIdstring required

Request body

xuidstring required
sessionNamestring required

Response

Invitation sent successfully

{"stackTrail":"components:schemas:ApiResponse:properties:content","oasType":"schema","type":"unknown","description":"The response payload from the upstream Xbox/Microsoft API. The structure varies by endpoint - can be an object, array, or string."}
codeinteger required

HTTP status code from the upstream API. Common values: 200 (success), 400 (bad request), 401 (unauthorized), 404 (not found), 410 (deprecated/gone), 429 (rate limited), 500 (server error)

Example response

{
  "code": 200
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.