POST party/host

Host a new multiplayer party.

Example

POST /api/v1/party/host HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer ...

{
  "name": "John's Party",
  "maxPlayers": 8
}
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "partyId": "d8357102-4518-45c5-b7b3-127bad36a723",
  "socketUrl": "wss://ws1.ws.prod.theendlessmission.com/party/d8357102-4518-45c5-b7b3-127bad36a723",
  "accessToken": "eyJhb...Qjg"
}

Security

Authentication is required.

URL Parameters

NONE

Query Parameters

NONE

Request Body

NameDescriptionValue
namethe display name for this party in listingsstring
maxPlayersthe number of players that can joinnumber

Response

Successful responses are code 200 with data in the response body. Other error responses are standard.

Response Body

NameDescriptionValue
partyIdthe ID of the party that was createdstring
socketUrlthe URL to use to establish a WebSocket connectionstring
accessTokena token granting access to the socket host, as a JWTstring