Sign in
session

Create a new party session

Creates a new Xbox party chat session with you as the host.

Session Properties

The created session has the following default properties:

  • Visibility: open - Anyone with the session name can view it
  • Join Restriction: followed - Only users you follow can join

After Creation

Once created, you can:

  1. Invite other users using POST /v2/session/invite/{sessionId}
  2. Share the session name for others to join
  3. Use RTA WebSocket to receive real-time updates

Session Name

The response includes a unique session name (UUID) that identifies this party. Use this name for all subsequent operations.

get/v2/session/create

Response

Created session details

{"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.