Skip to main content
POST
/
activity
/
playerJoin
Player joins a game session
curl --request POST \
  --url https://api.readmin.app/activity/playerJoin \
  --header 'Content-Type: application/json' \
  --header 'loader-id: <api-key>' \
  --data '{
  "playerId": 123,
  "platform": "Phone",
  "safechat": true,
  "username": "<string>",
  "tzOffset": "<string>"
}'
{
  "success": true,
  "banned": true,
  "reason": "<string>",
  "isStaff": true,
  "sessionId": "<string>",
  "runningPlayerId": "<string>"
}

Authorizations

​
loader-id
string
header
required

Body

application/json
​
playerId
number
required
​
platform
enum<string>
required
Available options:
Phone,
Tablet,
Console,
Desktop,
unknown
​
safechat
boolean
required
​
username
string
​
tzOffset
string

Response

​
success
boolean
​
banned
boolean
​
reason
string | null
​
isStaff
boolean
​
sessionId
string
​
runningPlayerId
string