POST party/{partyId}/join

Join a multiplayer party.

Example

POST /api/v1/party/d8357102-4518-45c5-b7b3-127bad36a723/join HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer ...
----------------------------------------
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

NameDescriptionValue
partyIdthe ID of the party to join, as a GUID with dashesstring

Query Parameters

NONE

Request Body

NONE

Response

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

Response Body

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