# Create a full lead

Creates a lead with all details provided in the request body. Returns a BookingSummaryDTO containing the ID and reference of the created lead.

Endpoint: POST /api/v3/leads
Version: 3.0.4
Security: OAuth2

## Query parameters:

  - `currentUser` (object, required)

## Request fields (application/json):

  - `startDate` (string, required)
    Start date of the booking
    Example: "2025-01-01"

  - `endDate` (string, required)
    End date of the booking
    Example: "2025-12-01"

  - `contactDetails` (object, required)
    Contact details of the lead

  - `contactDetails.firstName` (string, required)

  - `contactDetails.lastName` (string, required)

  - `contactDetails.email` (string, required)

  - `contactDetails.phone` (string)

  - `contactDetails.marketSegment` (string)

  - `bookingType` (string, required)
    Type of booking, should be the name of a booking type
    Example: "Default"

  - `unitTypes` (array, required)
    List of requested unit types, these are the generic unit type names from the PMS

  - `requestedLocation` (string, required)
    Requested location for the booking, this is a string that can be a building name or an area name
    Example: "Central London"

  - `budget` (number)
    Budget for the booking
    Example: 1500

  - `referrer` (string)
    Source of the lead/referrer information, the CODE of a referrer
    Example: "WEB"

  - `notes` (string)
    Additional notes about the lead, creates a note on the lead
    Example: "Looking for a pet-friendly unit"

  - `channel` (string)
    Channel through which the lead was created, by channel name
    Example: "ONLINE"

  - `selectedLocations` (array)
    List of selected location preferences, these are EITHER the names of buildings OR the ids of buildings as integers

## Response 200 fields (application/json):

  - `id` (integer)
    The unique identifier of the booking

  - `bookingReference` (string)
    The booking reference number