> ## Documentation Index
> Fetch the complete documentation index at: https://www.worldmonitor.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# RegisterInterest

> RegisterInterest adds an email to the Pro waitlist and sends a confirmation email. Turnstile-gated (desktop sources authenticate a bypass with a shared-secret HMAC instead). A failed Cloudflare Turnstile check returns 403 Bot verification failed; a desktop-source request with a missing or invalid HMAC signature returns 403 Desktop authentication failed.



## OpenAPI

````yaml /api/worldmonitor.openapi.yaml post /api/leads/v1/register-interest
openapi: 3.1.0
info:
  title: WorldMonitor API
  description: >-
    Unified OpenAPI bundle spanning all WorldMonitor services. Versioning and
    deprecation policy: https://www.worldmonitor.app/docs/api-versioning
  contact:
    name: WorldMonitor
    email: support@worldmonitor.app
  version: 1.0.0
servers:
  - url: https://api.worldmonitor.app
security:
  - WorldMonitorKey: []
  - ApiKeyHeader: []
paths:
  /api/leads/v1/register-interest:
    post:
      tags:
        - LeadsService
      summary: RegisterInterest
      description: >-
        RegisterInterest adds an email to the Pro waitlist and sends a
        confirmation email. Turnstile-gated (desktop sources authenticate a
        bypass with a shared-secret HMAC instead). A failed Cloudflare Turnstile
        check returns 403 Bot verification failed; a desktop-source request with
        a missing or invalid HMAC signature returns 403 Desktop authentication
        failed.
      operationId: RegisterInterest
      parameters:
        - name: Idempotency-Key
          in: header
          description: >-
            Optional client-generated idempotency key. Retrying a POST with the
            same key and an identical request body replays the original response
            (only the status, body, and Content-Type are reproduced) instead of
            re-executing; reusing the key with a different body is rejected with
            422. For mutations this avoids duplicating the side effect, while
            for batch-read POSTs it replays a cached snapshot that can be up to
            24 hours stale. Keys are scoped per authenticated caller (falling
            back to the source IP for unauthenticated endpoints) and retained
            for 24 hours.
          required: false
          example: 4f8b9c2e-1a3d-4b6f-8e0a-2c5d7f9b1e34
          schema:
            type: string
            minLength: 1
            maxLength: 255
            pattern: ^[\x21-\x7E]{1,255}$
      requestBody:
        content:
          application/json:
            example:
              appVersion: example
              email: analyst@example.com
              referredBy: example
              source: example
              turnstileToken: example
            schema:
              $ref: >-
                #/components/schemas/worldmonitor_leads_v1_RegisterInterestRequest
        required: true
      responses:
        '200':
          description: Successful response
          headers:
            Idempotency-Key:
              schema:
                type: string
              description: >-
                The idempotency key echoed from the request. Present only when
                the client opted into idempotency.
            Idempotent-Replayed:
              schema:
                type: boolean
              description: >-
                true when this response was replayed from an earlier request
                with the same key, false on the first (original) request.
                Present only when the client opted into idempotency.
          content:
            application/json:
              example:
                emailSuppressed: true
                position: 1
                referralCode: example
                referralCount: 1
                status: example
              schema:
                $ref: >-
                  #/components/schemas/worldmonitor_leads_v1_RegisterInterestResponse
        '400':
          description: >-
            Validation error, invalid Idempotency-Key header, or malformed JSON
            request body
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationError'
                  - type: object
                    required:
                      - error
                      - message
                    properties:
                      error:
                        type: string
                      message:
                        type: string
                  - $ref: '#/components/schemas/InvalidRequestBodyError'
        '403':
          description: Bot verification or desktop authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: A request with this Idempotency-Key is still being processed
          headers:
            Idempotency-Key:
              schema:
                type: string
              description: The idempotency key supplied by the client.
            Retry-After:
              schema:
                type: string
              description: Seconds to wait before retrying the in-flight request.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - message
                properties:
                  error:
                    type: string
                  message:
                    type: string
        '422':
          description: The Idempotency-Key was already used with a different request body
          headers:
            Idempotency-Key:
              schema:
                type: string
              description: The idempotency key supplied by the client.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - message
                properties:
                  error:
                    type: string
                  message:
                    type: string
        '429':
          description: Rate limit exceeded.
          headers:
            X-RateLimit-Limit:
              description: Maximum requests allowed in the active rate-limit window.
              schema:
                type: string
            X-RateLimit-Remaining:
              description: Requests remaining in the active rate-limit window.
              schema:
                type: string
            X-RateLimit-Reset:
              description: >-
                Unix epoch milliseconds when the active rate-limit window
                resets.
              schema:
                type: string
            Retry-After:
              description: Seconds to wait before retrying the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Error'
                  - $ref: '#/components/schemas/RateLimitError'
        default:
          description: Gateway or handler error response.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Error'
                  - $ref: '#/components/schemas/GatewayError'
      security: []
components:
  schemas:
    worldmonitor_leads_v1_RegisterInterestRequest:
      type: object
      properties:
        email:
          type: string
        source:
          type: string
        appVersion:
          type: string
        referredBy:
          type: string
        website:
          type: string
          description: >-
            Honeypot — bots auto-fill this hidden field; real submissions leave
            it empty.
        turnstileToken:
          type: string
          description: >-
            Cloudflare Turnstile token. Desktop sources bypass Turnstile; see
            handler.
      required:
        - email
        - turnstileToken
      description: RegisterInterestRequest carries a Pro-waitlist signup.
    worldmonitor_leads_v1_RegisterInterestResponse:
      type: object
      properties:
        status:
          type: string
          description: >-
            "registered" for a new signup; "already_registered" for a returning
            email.
        referralCode:
          type: string
          description: Stable referral code for this email.
        referralCount:
          type: integer
          format: int32
          description: Number of signups credited to this email.
        position:
          type: integer
          format: int32
          description: >-
            Waitlist position at registration time. Present only when status ==
            "registered".
        emailSuppressed:
          type: boolean
          description: >-
            True when the email is on the suppression list (prior bounce) and no
            confirmation was sent.
      description: >-
        RegisterInterestResponse mirrors the Convex registerInterest:register
        return shape.
    ValidationError:
      type: object
      properties:
        violations:
          type: array
          items:
            $ref: '#/components/schemas/FieldViolation'
          description: List of validation violations
      required:
        - violations
      description: >-
        ValidationError is returned when request validation fails. It contains a
        list of field violations describing what went wrong.
    InvalidRequestBodyError:
      type: object
      description: Returned when a JSON POST request body is empty or malformed.
      properties:
        message:
          type: string
          description: Invalid request body
      required:
        - message
    Error:
      type: object
      properties:
        message:
          type: string
          description: Error message (e.g., 'user not found', 'database connection failed')
      description: >-
        Error is returned when a handler encounters an error. It contains a
        simple error message that the developer can customize.
    RateLimitError:
      type: object
      description: Returned when a gateway or handler rate limit rejects the request.
      properties:
        error:
          type: string
          description: Human-readable rate-limit failure reason.
      required:
        - error
    GatewayError:
      type: object
      description: >-
        Returned by gateway infrastructure errors before an RPC handler runs,
        such as origin, routing, method, authentication, or quota checks.
      properties:
        error:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
          description: Gateway error reason or structured gateway failure details.
      required:
        - error
    FieldViolation:
      type: object
      properties:
        field:
          type: string
          description: >-
            The field path that failed validation (e.g., 'user.email' for nested
            fields). For header validation, this will be the header name (e.g.,
            'X-API-Key')
        description:
          type: string
          description: >-
            Human-readable description of the validation violation (e.g., 'must
            be a valid email address', 'required field missing')
      required:
        - field
        - description
      description: FieldViolation describes a single validation error for a specific field.
  securitySchemes:
    WorldMonitorKey:
      type: apiKey
      in: header
      name: X-WorldMonitor-Key
      description: User-issued WorldMonitor API key.
    ApiKeyHeader:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Alias header for the WorldMonitor API key (X-WorldMonitor-Key).

````