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

# Create a new referral

> Submit a referral for a demo. This is an unauthenticated endpoint.



## OpenAPI

````yaml https://zeropath.com/openapi/v1.yaml post /api/v1/referral/create
openapi: 3.1.0
info:
  title: ZeroPath API
  version: 1.0.0
  description: Public API for ZeroPath
servers:
  - url: https://zeropath.com
    description: Production server
    x-fern-server-name: Production
  - url: https://dev.branch.zeropath.com
    description: Development server
    x-fern-server-name: Development
security:
  - apiTokenId: []
    apiTokenSecret: []
tags:
  - name: Organizations
    description: Operations related to organizations
  - name: Stats
    description: Operations related to stats
  - name: Repositories
    description: Operations related to repositories
  - name: Installations
    description: Operations related to installations
  - name: Issues
    description: Operations related to issues
  - name: SCA
    description: Software Composition Analysis
  - name: Scans
    description: Operations related to scans
  - name: Rules
    description: Operations related to custom security rules
  - name: Referrals
    description: Operations related to referrals
paths:
  /api/v1/referral/create:
    post:
      tags:
        - Referrals
      summary: Create a new referral
      description: Submit a referral for a demo. This is an unauthenticated endpoint.
      operationId: createReferral
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReferralRequest'
      responses:
        '200':
          description: Referral created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateReferralResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
components:
  schemas:
    CreateReferralRequest:
      type: object
      required:
        - firstName
        - lastName
        - email
        - mobilePhone
        - companyName
        - referrerFirstName
        - referrerLastName
        - referrerEmail
        - type
      properties:
        firstName:
          type: string
          minLength: 1
          maxLength: 100
          description: First name of the referred person
        lastName:
          type: string
          minLength: 1
          maxLength: 100
          description: Last name of the referred person
        email:
          type: string
          format: email
          description: Email address of the referred person
        mobilePhone:
          type: string
          minLength: 10
          maxLength: 20
          description: Mobile phone number of the referred person
        companyName:
          type: string
          minLength: 1
          maxLength: 200
          description: Company name of the referred person
        notes:
          type: string
          maxLength: 1000
          description: Optional notes about the referral
        referrerFirstName:
          type: string
          minLength: 1
          maxLength: 100
          description: First name of the person making the referral
        referrerLastName:
          type: string
          minLength: 1
          maxLength: 100
          description: Last name of the person making the referral
        referrerEmail:
          type: string
          format: email
          description: Email address of the person making the referral
        type:
          type: string
          enum:
            - DEMO
          description: Type of referral
    CreateReferralResponse:
      type: object
      required:
        - success
        - referralId
      properties:
        success:
          type: boolean
          description: Whether the referral was created successfully
        referralId:
          type: string
          format: uuid
          description: Unique identifier of the created referral
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
  securitySchemes:
    apiTokenId:
      type: apiKey
      in: header
      name: X-ZeroPath-API-Token-Id
      x-fern-header:
        name: apiTokenId
        env: ZEROPATH_API_TOKEN_ID
    apiTokenSecret:
      type: apiKey
      in: header
      name: X-ZeroPath-API-Token-Secret
      x-fern-header:
        name: apiTokenSecret
        env: ZEROPATH_API_TOKEN_SECRET

````