---
title: "Sign up as an app tester"
method: POST
path: "/api/testers"
tags: ["account"]
---

# Sign up as an app tester

`POST /api/testers`

## Request

- Base URL: `https://voltplan.app`
- URL: `https://voltplan.app/api/testers`
- Auth: none required

No authentication. Creates an `app_testers` record `{ email, name, platform, status: "pending", locale, source }` with an unauthenticated PocketBase client (`POCKETBASE_URL`); no superuser client is involved.

- The email is validated first (400 `A valid email is required`), then the name (400 `Name is required`).
- A PocketBase `validation_not_unique` error on any field (unique index on email + platform) answers 200 with `isExisting: true`.
- Any other PocketBase failure answers 500 `Failed to sign up`; a non-JSON or `null` body answers 500 `Internal server error`.

## Request body

- TestersRequest
  - `email` string, required: Trimmed and lowercased server-side (`trim().toLowerCase()`); must then match `^[^\s@]+@[^\s@]+\.[^\s@]+$`. A non-string value is treated as missing.
  - `name` string, required: Trimmed; must be non-empty. A non-string value is treated as missing.
  - `platform` 'android' | 'ios': Any other value is stored as android.
  - `locale` string: Truncated to 8 characters; default empty string.
  - `source` string: Truncated to 64 characters.

## Response `200`

On the tester list (new or existing).

- union: Newly added to, or already on, the tester list.
  - TestersCreatedResponse: Added to the tester list.
    - `success` unknown, required
    - `message` 'You are on the tester list', required
  - TestersExistingResponse: Already on the tester list for this platform.
    - `success` unknown, required
    - `message` 'Already on the tester list', required
    - `isExisting` unknown, required

## Other responses

- `400`: Email missing or malformed, or name missing.
- `500`: PocketBase failed, or the body could not be read.

---

[API](https://skmtc.dev/voltplan/apis/voltplan-api.md) · [All operations](https://skmtc.dev/voltplan/apis/voltplan-api/llms.txt) · [OpenAPI document](https://skmtc.dev/voltplan/apis/voltplan-api/revisions/575b86a7af92?raw)
