POST
/
api
/
v1
/
admin
/
simulation
/
team-sessions
/
{session_id}
/
join
Join Team Simulation Session
curl --request POST \
  --url https://api.jobsim.work/api/v1/admin/simulation/team-sessions/{session_id}/join \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "display_name": "<string>",
  "role": "participant",
  "status": "joined",
  "metadata": {}
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
session_id
string
required

Body

application/json

Request payload for joining a multiplayer simulation session.

​
user_id
string
required
​
display_name
string | null
​
role
string
default:participant
​
status
string
default:joined
​
metadata
Metadata · object

Response

Successful Response