---
title: "POST /leads"
method: POST
path: "/leads"
tags: ["LeadController"]
---

# POST /leads

`POST /leads`

## Request body

- CreateLeadDTO — model describing payload used to create a lead (tsType: Omit<CreateLeadDTO, 'isValidated' | 'addressId' | 'id'>, schemaOptions: { title: 'CreateLeadDTO', exclude: [ 'isValidated', 'addressId', 'id' ] })
  - `deleted` boolean
  - `deletedOn` string, date-time, nullable
  - `deletedBy` string, nullable
  - `createdOn` string, date-time
  - `modifiedOn` string, date-time
  - `createdBy` string
  - `modifiedBy` string
  - `firstName` string, required — first name of the lead
  - `lastName` string, required — last name of the lead
  - `companyName` string, required — name of the lead's company
  - `email` string, required — email of the lead
  - `address` object — this model represents the address of a company or lead (tsType: @loopback/repository-json-schema#Optional<Omit<Address, 'id'>, 'country'>, schemaOptions: { exclude: [ 'id' ], optional: [ 'country' ] })
    - `deleted` boolean
    - `deletedOn` string, date-time, nullable
    - `deletedBy` string, nullable
    - `createdOn` string, date-time
    - `modifiedOn` string, date-time
    - `createdBy` string
    - `modifiedBy` string
    - `address` string — address of the company
    - `city` string — city of the company
    - `state` string — state of the company
    - `zip` string — zip code of the company
    - `country` string — country of the company

## Response `200`

Lead model instance

- Lead — this model represents a lead that could eventually be a tenant in the system
  - `deleted` boolean
  - `deletedOn` string, date-time, nullable
  - `deletedBy` string, nullable
  - `createdOn` string, date-time
  - `modifiedOn` string, date-time
  - `createdBy` string
  - `modifiedBy` string
  - `id` string
  - `firstName` string, required — first name of the lead
  - `lastName` string, required — last name of the lead
  - `companyName` string, required — name of the lead's company
  - `email` string, required — email of the lead
  - `isValidated` boolean, required — whether the lead`s email has been validated or not
  - `addressId` string — id of the address of the lead

---

[API](https://skmtc.net/sourcefuse/apis/tenant-management-service.md) · [All operations](https://skmtc.net/sourcefuse/apis/tenant-management-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sourcefuse/tenant-management-service/versions/0dce7cf133e9/schema)