RankGun logoRankGun

Create Session

Create a new scheduled session.

POST /api/sessions

Creates a new scheduled session. The new session starts in scheduled status.

The actorRobloxId must resolve to an existing workspace member. That member is recorded as the session creator and as the actor on audit log entries.

scheduledStartAt and scheduledEndAt are seconds since epoch, not milliseconds. See the Timestamps section.

Each workspace may hold at most 10,000 sessions total (across all statuses — scheduled, in-progress, completed, and cancelled). Requests that would exceed this cap return 400 with a message instructing you to delete or archive old sessions.

Headers

Prop

Type

Request Body

Prop

Type

curl -X POST https://api.rankgun.works/api/sessions \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "actorRobloxId": 123456,
    "sessionTypeId": "j5abc...",
    "title": "Saturday Training",
    "scheduledStartAt": 1712345678,
    "scheduledEndAt": 1712349278,
    "notes": "Bring your A game"
  }'

Response

201 Created

Response shape matches Get Session{ success, session, participants }. Participants will be an empty array since the session has just been created.

Errors

StatusMeaning
400Validation error (bad fields, invalid timestamps, unknown actor, sessionTypeId from a different workspace, workspace session limit reached).
401Missing API key.
403Invalid API key.
500Internal server error.
Was this page helpful?

On this page