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

# Add a new waitlist

> Send a POST request with the email of the user and optionally a ref string to add a new waitlist entry. Returns the newly created waitlist entry with the waiting number and created_at timestamp. A corresponding Knock user will also be created with the same ID and email.



## OpenAPI

````yaml post /waitlist/
openapi: 3.0.3
info:
  title: Letraz Backend Server
  version: 0.1.0
  description: >-
    This is the backend service repository of Letraz. Create tailored resumes
    for every job application effortlessly with Letraz. Our AI-powered tool
    helps you stand out by automatically optimizing your resume for ATS and
    recruiters, ensuring your skills and experience match the job's
    requirements.
servers:
  - url: https://api.letraz.app/api/v1
    description: Production Server
  - url: http://localhost:8000/api/v1
    description: Local Development Server
security: []
tags:
  - name: Core APIs
    description: Core APIs for Letraz Backend
  - name: Waitlist
    description: >-
      Mange waitlist, signups, retrieve waitlist and everything related to
      waitlist
  - name: User
    description: Get or update user details of currently logged in user
  - name: Job object
    description: >-
      Manage job objects, retrieve job objects and everything related to job
      objects
  - name: Resume object
    description: >-
      Manage resume objects, retrieve resume objects and everything related to
      resume objects
  - name: Education object
    description: >-
      Manage education objects, retrieve education objects and everything
      related to education objects
  - name: Experience object
    description: >-
      Manage experience objects, retrieve experience objects and everything
      related to experience objects
paths:
  /waitlist/:
    post:
      tags:
        - Waitlist
      summary: Add a new waitlist
      description: >-
        Send a POST request with the email of the user and optionally a ref
        string to add a new waitlist entry. Returns the newly created waitlist
        entry with the waiting number and created_at timestamp. A corresponding
        Knock user will also be created with the same ID and email.
      operationId: waitlist_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Waitlist'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Waitlist'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Waitlist'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Waitlist'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: ''
components:
  schemas:
    Waitlist:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: The unique identifier for the waitlist entry.
        email:
          type: string
          format: email
          description: The email of the user who joined the waitlist.
          maxLength: 254
        referrer:
          type: string
          description: >-
            The referrer of the user who joined the waitlist. Usually the source
            they have come from.
          maxLength: 50
        waiting_number:
          type: integer
          readOnly: true
          description: The waiting number of the user who joined the waitlist.
        has_access:
          type: boolean
          readOnly: true
          description: Whether the user has been granted access to the platform.
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: The timestamp at which the user joined the waitlist.
      required:
        - created_at
        - email
        - has_access
        - id
        - waiting_number
    ErrorEnvelope:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Error'
      required:
        - error
    Error:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            The unique identifier for the error response. This is useful for
            tracking the error in the logs and in Sentry if it is enabled.
        code:
          type: string
          description: >-
            The error code that is unique to the error type. This can be used to
            identify the error type and can be used for debugging.
        message:
          type: string
          description: >-
            The error message that is human readable and can be used to
            understand the error. Usually fit to be displayed to the user.
        details:
          type: string
          description: >-
            The error details that can be used to understand the error in more
            detail. This can be used for debugging purposes.
        extra:
          type: string
          description: >-
            The extra data that can be used to understand the error in more
            detail. This is usually not displayed to the user and might include
            stacktrace and sensitive information.
      required:
        - code
        - details
        - extra
        - message
        - uuid

````