Skip to main content
PUT
Update play session configuration

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Path Parameters

session_id
string
required

Play session to configure.

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

Body

application/json
kind
string
required

Selects a different Coworld version.

Allowed value: "coworld"
coworld_id
string
required

Coworld version to select.

Pattern: ^cow_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

Successful Response

coworld_id
string
required

Coworld version selected for the session.

game_name
string
required

Name of the selected game.

variant_id
string | null
required

Selected game variant, if any.

player_count
integer
required

Number of player seats.

slots_filled
integer
required

Number of occupied player seats.

allow_spectators
boolean
required

Whether spectators may join.

global_url
string | null
required

Shared viewer URL.

status
string
required

Current session status.

game_config
Game Config · object | null

Resolved public game configuration.

can_manage
boolean
default:false

Whether the caller may manage the session.

viewer_target_url
string | null

Viewer URL for the current caller, when ready.

players
PlaySessionPlayerResponse · object[]

Player seat assignments.

spectators
PlaySessionSpectatorResponse · object[]

Joined spectators.

can_configure_game
boolean
default:false

Whether the selected Coworld supports lobby game configuration.