RankGun logoRankGun

Update Session Participant

Update a participant's role or attendance status.

PATCH /api/sessions/{sessionId}/participants/{robloxId}

Update a participant's role and/or attendance status. Setting attendanceStatus also records respondedAt as the current time.

At least one of role or attendanceStatus must be provided. Sending neither returns 400.

Roles must exist in the workspace first. When updating role, the new value must match the exact name of a role configured in the dashboard under Sessions → Roles. Unknown role names return 400 with the list of valid role names.

Headers

Prop

Type

Path Parameters

Prop

Type

Request Body

At least one of role or attendanceStatus must be provided.

Prop

Type

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

Response

200 OK

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

Participant fields match the Get Session participant shape.

Errors

StatusMeaning
400Validation error (neither field provided, bad body, unknown actor, unknown role name).
401Missing API key.
403Invalid API key.
404Session not found in this workspace, or the session exists but no participant with the given robloxId is attached to it (the error message distinguishes between the two cases).
500Internal server error.
Was this page helpful?

On this page