Join the waitlist

POST /v1/public/waitlist

• Operation ID: joinWaitlist
• Tags: Public site
• Base URL: http://localhost:8787

Idempotent per email: joining again returns 200 with alreadyJoined: true and the existing position instead of creating a new entry.

Workflow: Integration guide.

Authentication: none (public).

Rate limit: 5 requests per 60s per ip.

Authentication

• Auth: none (public endpoint, no token required).

Rate limit

5 requests per 60 seconds per ip. Exceeding it returns 429.

Request body

Required: yes.

Content type: application/json

Schema: object

Field	Type	Required	Description
email	string<email>	yes	Max length: 320
source	string	no	Max length: 100
referralCode	string	no	Max length: 100
metadata	object	no	Default: {}

Example

{
  "email": "player@example.com",
  "source": "docs"
}

Responses

200

Email was already on the waitlist.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (PublicWaitlistJoinResult)

Field	Type	Required	Description
id	string<uuid>	yes	-
position	integer | null	yes	Place in the queue; null when not assigned.
alreadyJoined	boolean	yes	-

201

Newly added to the waitlist.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (PublicWaitlistJoinResult), fields as described above.

Example

{
  "id": "3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90",
  "position": 1,
  "alreadyJoined": false
}

Errors

400

Request validation failed.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ValidationErrorBody)

Field	Type	Required	Description
success	boolean	yes	One of: false
error	object	yes	-
error.name	string	yes	One of: "ZodError"
error.issues	object[]	yes	-
error.issues[].code	string	yes	-
error.issues[].path	(string | number)[]	yes	-
error.issues[].message	string	yes	-

Request validation

{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}

429

Rate limit exceeded (rate_limited).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "rate_limited"
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

503

Maintenance can refuse this write before authentication (degraded blocks session start and checkout; lockdown blocks other public/user writes).

• Header x-request-id: Request identifier; quote it when reporting an error.
• Header Retry-After: Maintenance retry delay in seconds; present for panic_mode. Example: 30. Content type: application/json

Schema: object (MaintenanceErrorBody)

Field	Type	Required	Description
error	string	yes	One of: "panic_mode"
level	string	yes	One of: "degraded", "lockdown"
reason	string | null	yes	-

Maintenance lockdown

{
  "error": "panic_mode",
  "level": "lockdown",
  "reason": "Scheduled maintenance"
}

Examples

curl

curl -X POST 'http://localhost:8787/v1/public/waitlist' \
  -H 'Content-Type: application/json' \
  --data '{"email":"player@example.com","source":"docs"}'

TypeScript

const response = await fetch("http://localhost:8787/v1/public/waitlist", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": "player@example.com",
    "source": "docs"
  }),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();