Join play session | Softmax docs

POST/v2/coworlds/play/session/{session_id}/join

Claims an open player seat or joins as a spectator.

Authorization

BearerAuth

AuthorizationBearer <token>

Bearer token issued by Softmax

In: header

Path Parameters

session_id*Session Id

Play session to join.

Match^ps_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query Parameters

spectate?Spectate

Join as a spectator even when a player seat is available.

Defaultfalse

entrant_id?|

Stable anonymous entrant ID used to reuse an existing claim.

bash

curl -X POST "https://example.com/v2/coworlds/play/session/string/join"

json

{
  "entrant_kind": "player",
  "target_url": "string",
  "slot": 0,
  "player": {
    "slot": 0,
    "label": "string",
    "slot_kind": "human",
    "user_id": "string",
    "player_id": "string",
    "player_name": "string",
    "policy_version_id": "7cd41427-f4be-4006-ab17-5ead7f8f8446",
    "policy_name": "string",
    "policy_version": 0,
    "joined_at": "2019-08-24T14:15:22Z",
    "is_viewer": false
  },
  "spectator": {
    "label": "string",
    "player_id": "string",
    "player_name": "string",
    "joined_at": "2019-08-24T14:15:22Z",
    "is_viewer": false
  }
}