RankGun logoRankGun
API ReferenceSessions

Add Session Participant

Add a workspace member as a participant of a session.

POST /api/sessions/{sessionId}/participants

Adds a workspace member to a session. The target robloxId must be an existing workspace member.

Returns 409 Conflict if the participant is already attached to this session.

Roles must exist in the workspace first. The role field must match the exact name of a role configured in the dashboard under Sessions → Roles. Passing an unknown role name returns 400 with the list of valid role names. If role is omitted, the workspace's default role (the one marked isDefault) is used; if no default is configured, the request is rejected with a 400 asking you to provide one explicitly.

Headers

Prop

Type

Path Parameters

Prop

Type

Request Body

Prop

Type

curl -X POST https://api.rankgun.works/api/sessions/k7abc/participants \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "actorRobloxId": 123456,
    "robloxId": 987654,
    "role": "Trainer",
    "attendanceStatus": "confirmed"
  }'

Response

201 Created

{
  "success": true,
  "participant": {
    "robloxId": 987654,
    "robloxUsername": "Player1",
    "displayName": "Player One",
    "role": "Trainer",
    "attendanceStatus": "confirmed",
    "invitedAt": 1712345678,
    "respondedAt": null
  }
}

Participant fields match the Get Session participant shape.

Errors

StatusMeaning
400Validation error (bad body, unknown actor, target not a workspace member, unknown role name, or no default role configured when role is omitted).
401Missing API key.
403Invalid API key.
404Session not found.
409Participant already exists on this session.
500Internal server error.
Was this page helpful?

Update Session Status

Transition a session to in_progress, completed, or cancelled.

Update Session Participant

Update a participant's role or attendance status.

On this page

Headers
Path Parameters
Request Body
Response
Errors