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

# Create lead



## OpenAPI

````yaml POST /locations/{locationId}/leads
openapi: 3.1.0
info:
  title: PickupBell API
  version: 1.0.0
  description: >
    Public REST surface for PickupBell — the AI receptionist for HVAC, plumbing,
    and home-services contractors.


    All requests authenticate via `Authorization: Bearer <uuid>`. Every response
    is JSON with shape `{ "data": … }` (or `{ "error": { "code", "message",
    "details" } }` on failure).


    Only endpoints an API token can successfully call are documented here.
    UI-only operations (create location, invite member, mint / revoke API key,
    billing checkout / portal) require a user session and are not part of the
    public API.
  contact:
    email: support@pickupbell.com
servers:
  - url: https://api.pickupbell.com
    description: >-
      Production (vanity domain — Vercel rewrite proxies to
      app.pickupbell.com/api/v1)
  - url: https://app.pickupbell.com/api/v1
    description: App-domain alias (works without the rewrite)
  - url: http://localhost:3000/api/v1
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Me
  - name: Locations
  - name: Members
  - name: API keys
  - name: Agent
  - name: Business hours
  - name: Call forwarding
  - name: FAQs
  - name: Pricebook
  - name: Calls
  - name: Leads
  - name: Bookings
  - name: Insights
  - name: Notifications
  - name: Integrations
  - name: Webhook endpoints
paths:
  /locations/{locationId}/leads:
    parameters:
      - $ref: '#/components/parameters/WorkspaceId'
    post:
      tags:
        - Leads
      summary: Create a lead manually
      operationId: createLead
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeadCreate'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Lead'
components:
  parameters:
    WorkspaceId:
      name: locationId
      in: path
      required: true
      schema:
        type: string
      description: Location UUID or slug (e.g. `premier-hvac`).
  schemas:
    LeadCreate:
      type: object
      properties:
        name:
          type: string
        phone:
          type: string
        email:
          type: string
          format: email
        address:
          type: string
        service_type:
          type: string
        urgency_level:
          type: integer
          minimum: 0
          maximum: 5
        estimated_value:
          type: number
        notes:
          type: string
    Lead:
      type: object
      properties:
        id:
          type: string
          format: uuid
        location_id:
          type: string
          format: uuid
        call_id:
          type: string
          format: uuid
          nullable: true
        customer_id:
          type: string
          format: uuid
          nullable: true
        name:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
          description: Masked on API responses
        email:
          type: string
          nullable: true
          description: Masked on API responses
        address:
          type: string
          nullable: true
        service_type:
          type: string
          nullable: true
        urgency_level:
          type: integer
          minimum: 0
          maximum: 5
        estimated_value:
          type: number
          nullable: true
        status:
          type: string
          enum:
            - new
            - contacted
            - booked
            - closed
            - lost
        status_changed_at:
          type: string
          format: date-time
        assigned_to:
          type: string
          format: uuid
          nullable: true
        notes:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: uuid
      description: Location-scoped API token from **Settings → API & MCP**.

````