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

# Send a lead

> Send a lead details to Hestia

This endpoint is used to send a lead to Hestia.

<Note>
  Make sure you have the user consent before sending us the lead. We will
  contact it.
</Note>

## Parameters

<RequestExample>
  ```json theme={null}
  {
    "firstName": "Thomas",
    "lastName": "Pesquet",
    "email": "thomas.pesquet@example.com",
    "phoneNumber": "+33123456789",
    "additionalDetails": "Looking to purchase a house in the suburbs.",
    "monthlyDebt": 500,
    "monthlyIncome": 3000,
    "savingsAvailable": 20000,
    "postalCode": "75001",
    "additionalContext": {
      "id": "ac93af55-671b-47c9-a80d-6a7600b3e561",
      "url": "https://example.com/property/ac93af55",
      "title": "Charming 3-bedroom house",
      "description": "A beautiful house located in a quiet neighborhood, with a large garden and modern amenities.",
      "price": 1500000,
      "latitude": 48.866667,
      "longitude": 2.333333,
      "size": 120,
      "rooms": 3,
      "images": [
        "https://example.com/image1.jpg",
        "https://example.com/image2.jpg"
      ],
      "energyPerformanceCertificate": "B",
      "isBridgeLoan": true,
      "leasingReason": "BANK_LOAN_REFUSAL",
    }
  }

  ```
</RequestExample>

<ParamField body="firstName" type="string" required placeholder="John">
  The user first name.
</ParamField>

<ParamField body="lastName" type="string" required placeholder="Doe">
  The user last name.
</ParamField>

<ParamField body="email" type="string" required placeholder="john.doe@example.com">
  The user email.
</ParamField>

<ParamField body="phoneNumber" type="string" required placeholder="+33123456789">
  The user phone number.
</ParamField>

<ParamField body="additionalDetails" type="string" optional placeholder="Looking to purchase a house in the suburbs.">
  Any additional details about the user project / situation.
</ParamField>

<ParamField body="monthlyDebt" type="number" required placeholder="500">
  The total loan repayments per month. This field is used to calculate the debt
  ratio.
</ParamField>

<ParamField body="monthlyIncome" type="number" required placeholder="3000">
  The net income per month.
</ParamField>

<ParamField body="savingsAvailable" type="number" required placeholder="20000">
  The total amount of his assets (real estate, passbooks, current account,
  liquid investments at 15 months...etc).
</ParamField>

<ParamField body="postalCode" type="string" required placeholder="75001">
  Postal code of purchase project.
</ParamField>

<ParamField body="additionalContext" type="object" optional expandable>
  <Expandable title="properties">
    <ParamField body="id" type="string" optional placeholder="ac93af55-671b-47c9-a80d-6a7600b3e561">
      The unique identifier for the asset.
    </ParamField>

    <ParamField body="url" type="string" optional placeholder="https://example.com/property/ac93af55">
      The URL link to the detailed asset listing.
    </ParamField>

    <ParamField body="title" type="string" optional placeholder="Charming 3-bedroom house">
      A brief title describing the asset.
    </ParamField>

    <ParamField body="description" type="string" optional placeholder="A beautiful house located in a quiet neighborhood, with a large garden and modern amenities.">
      A detailed description of the asset, including features and amenities.
    </ParamField>

    <ParamField body="price" type="number" optional placeholder="350000">
      The listing price of the asset in euros.
    </ParamField>

    <ParamField body="latitude" type="number" optional placeholder="48.866667">
      The latitude of the asset location.
    </ParamField>

    <ParamField body="longitude" type="number" optional placeholder="2.333333">
      The longitude of the asset location.
    </ParamField>

    <ParamField body="size" type="number" optional placeholder="120">
      The total size of the asset in square meters.
    </ParamField>

    <ParamField body="rooms" type="number" optional placeholder="3">
      The total number of rooms in the asset.
    </ParamField>

    <ParamField body="images" type="array" optional placeholder="[&#x22;https://example.com/image1.jpg&#x22;, &#x22;https://example.com/image2.jpg&#x22;]">
      An array of URLs linking to images of the asset.
    </ParamField>

    <ParamField body="energyPerformanceCertificate" type="string" optional placeholder="B">
      The Energy Performance Certificate (EPC or DPE in french) rating of the
      asset.
    </ParamField>

    <ParamField body="isBridgeLoan" type="boolean" optional placeholder="true">
      Indicates whether the user is seeking a bridge loan.
    </ParamField>

    <ParamField body="leasingReason" type="string" optional placeholder="true" enum={["BANK_LOAN_REFUSAL", "ANTICIPATE_LOAN_REJECTION"]}>
      The reason the user is exploring leasing options. <br />
      Possible values are `BANK_LOAN_REFUSAL` if the bank has denied a loan, or `ANTICIPATE_LOAN_REJECTION` if the user anticipates loan rejection.
    </ParamField>
  </Expandable>
</ParamField>

## Response

If you get a `201`, we got the lead!

```
```