---
title: "Create Lead"
method: POST
path: "/Lead"
tags: ["Lead"]
---

# Create Lead

`POST /Lead`

Create a new 'Lead' record.

## Headers

- `X-Skip-Duplicate-Check` 'true' | 'false'
- `X-Duplicate-Source-Id` string

## Request body

- LeadCreate
  - `id` string — An ID.
  - `salutationName` 'Mr.' | 'Ms.' | 'Mrs.' | 'Dr.', nullable
  - `firstName` string, nullable — A one-line string.
  - `lastName` string, nullable — A one-line string.
  - `title` string, nullable — A one-line string.
  - `status` 'New' | 'Assigned' | 'In Process' | 'Converted' | 'Recycled' | 'Dead'
  - `source` 'Call' | 'Email' | 'Existing Customer' | 'Partner' | 'Public Relations' | 'Web Site' | 'Campaign' | 'Other', nullable
  - `industry` 'Advertising' | 'Aerospace' | 'Agriculture' | 'Apparel & Accessories' | 'Architecture' | 'Automotive' | 'Banking' | 'Biotechnology' | 'Building Materials & Equipment' | 'Chemical' | 'Construction' | 'Consulting' | 'Computer' | 'Culture' | 'Creative' | 'Defense' | 'Education' | 'Electronics' | 'Electric Power' | 'Energy' | 'Entertainment & Leisure' | 'Finance' | 'Food & Beverage' | 'Grocery' | 'Healthcare' | 'Hospitality' | 'Insurance' | 'Legal' | 'Manufacturing' | 'Mass Media' | 'Marketing' | 'Mining' | 'Music' | 'Publishing' | 'Petroleum' | 'Real Estate' | 'Retail' | 'Service' | 'Sports' | 'Software' | 'Support' | 'Shipping' | 'Travel' | 'Technology' | 'Telecommunications' | 'Television' | 'Transportation' | 'Testing, Inspection & Certification' | 'Venture Capital' | 'Wholesale' | 'Water', nullable
  - `opportunityAmount` number, nullable — A currency amount.
  - `opportunityAmountCurrency` 'USD' | 'EUR', nullable — A code.
  - `opportunityAmountConverted` number, nullable — A currency amount converted to the default currency.
  - `website` string, nullable — A one-line string.
  - `addressStreet` string, nullable — A multi-line text.
  - `addressCity` string, nullable — A one-line string.
  - `addressState` string, nullable — A one-line string.
  - `addressCountry` string, nullable — A one-line string.
  - `addressPostalCode` string, nullable — A one-line string.
  - `emailAddress` string, nullable — A primary email address.
  - `emailAddressData` object[], nullable — Multiple email addresses
    - `emailAddress` string, required
    - `primary` boolean, required
    - `optOut` boolean
    - `invalid` boolean
    - `lower` string
  - `phoneNumber` string, nullable — A primary phone number.
  - `phoneNumberData` object[], nullable — Multiple phone numbers.
    - `phoneNumber` string, required
    - `primary` boolean, required
    - `optOut` boolean
    - `invalid` boolean
    - `type` 'Mobile' | 'Office' | 'Home' | 'Fax' | 'Other'
  - `doNotCall` boolean
  - `description` string, nullable — A multi-line text.
  - `convertedAt` string, nullable — A timestamp in UTC.
  - `createdAt` string, nullable — A timestamp in UTC.
  - `modifiedAt` string, nullable — A timestamp in UTC.
  - `createdById` string, nullable — An ID of the record of the User type.
  - `createdByName` string, nullable — A foreign record name.
  - `modifiedById` string, nullable — An ID of the record of the User type.
  - `modifiedByName` string, nullable — A foreign record name.
  - `accountName` string, nullable — A one-line string.
  - `assignedUserId` string, nullable — An ID of the record of the User type.
  - `assignedUserName` string, nullable — A foreign record name.
  - `acceptanceStatusMeetings` string
  - `acceptanceStatusCalls` string
  - `teamsIds` string[], nullable — IDs of records of the Team type.
  - `teamsNames` object, nullable — An {ID => record name} map.
  - `campaignId` string, nullable — An ID of the record of the Campaign type.
  - `campaignName` string, nullable — A foreign record name.
  - `createdAccountId` string, nullable — An ID of the record of the Account type.
  - `createdAccountName` string, nullable — A foreign record name.
  - `createdContactId` string, nullable — An ID of the record of the Contact type.
  - `createdContactName` string, nullable — A foreign record name.
  - `createdOpportunityId` string, nullable — An ID of the record of the Opportunity type.
  - `createdOpportunityName` string, nullable — A foreign record name.
  - `targetListsIds` string[], nullable — IDs of records of the TargetList type.
  - `targetListsNames` object, nullable — An {ID => record name} map.
  - `targetListId` string, nullable
  - `targetListName` string, nullable — A foreign record name.
  - `originalEmailId` string, nullable
  - `originalEmailName` string, nullable — A foreign record name.
  - `middleName` string, nullable — A one-line string.
  - `emailAddressIsOptedOut` boolean
  - `emailAddressIsInvalid` boolean
  - `phoneNumberIsOptedOut` boolean
  - `phoneNumberIsInvalid` boolean
  - `streamUpdatedAt` string, nullable — A timestamp in UTC.

## Response `200`

Success.

- Lead
  - `id` string — An ID.
  - `salutationName` 'Mr.' | 'Ms.' | 'Mrs.' | 'Dr.', nullable
  - `firstName` string, nullable — A one-line string.
  - `lastName` string, nullable — A one-line string.
  - `title` string, nullable — A one-line string.
  - `status` 'New' | 'Assigned' | 'In Process' | 'Converted' | 'Recycled' | 'Dead'
  - `source` 'Call' | 'Email' | 'Existing Customer' | 'Partner' | 'Public Relations' | 'Web Site' | 'Campaign' | 'Other', nullable
  - `industry` 'Advertising' | 'Aerospace' | 'Agriculture' | 'Apparel & Accessories' | 'Architecture' | 'Automotive' | 'Banking' | 'Biotechnology' | 'Building Materials & Equipment' | 'Chemical' | 'Construction' | 'Consulting' | 'Computer' | 'Culture' | 'Creative' | 'Defense' | 'Education' | 'Electronics' | 'Electric Power' | 'Energy' | 'Entertainment & Leisure' | 'Finance' | 'Food & Beverage' | 'Grocery' | 'Healthcare' | 'Hospitality' | 'Insurance' | 'Legal' | 'Manufacturing' | 'Mass Media' | 'Marketing' | 'Mining' | 'Music' | 'Publishing' | 'Petroleum' | 'Real Estate' | 'Retail' | 'Service' | 'Sports' | 'Software' | 'Support' | 'Shipping' | 'Travel' | 'Technology' | 'Telecommunications' | 'Television' | 'Transportation' | 'Testing, Inspection & Certification' | 'Venture Capital' | 'Wholesale' | 'Water', nullable
  - `opportunityAmount` number, nullable — A currency amount.
  - `opportunityAmountCurrency` 'USD' | 'EUR', nullable — A code.
  - `opportunityAmountConverted` number, nullable — A currency amount converted to the default currency.
  - `website` string, nullable — A one-line string.
  - `addressStreet` string, nullable — A multi-line text.
  - `addressCity` string, nullable — A one-line string.
  - `addressState` string, nullable — A one-line string.
  - `addressCountry` string, nullable — A one-line string.
  - `addressPostalCode` string, nullable — A one-line string.
  - `emailAddress` string, nullable — A primary email address.
  - `emailAddressData` object[], nullable — Multiple email addresses
    - `emailAddress` string, required
    - `primary` boolean, required
    - `optOut` boolean
    - `invalid` boolean
    - `lower` string
  - `phoneNumber` string, nullable — A primary phone number.
  - `phoneNumberData` object[], nullable — Multiple phone numbers.
    - `phoneNumber` string, required
    - `primary` boolean, required
    - `optOut` boolean
    - `invalid` boolean
    - `type` 'Mobile' | 'Office' | 'Home' | 'Fax' | 'Other'
  - `doNotCall` boolean
  - `description` string, nullable — A multi-line text.
  - `convertedAt` string, nullable — A timestamp in UTC.
  - `createdAt` string, nullable — A timestamp in UTC.
  - `modifiedAt` string, nullable — A timestamp in UTC.
  - `createdById` string, nullable — An ID of the record of the User type.
  - `createdByName` string, nullable — A foreign record name.
  - `modifiedById` string, nullable — An ID of the record of the User type.
  - `modifiedByName` string, nullable — A foreign record name.
  - `accountName` string, nullable — A one-line string.
  - `assignedUserId` string, nullable — An ID of the record of the User type.
  - `assignedUserName` string, nullable — A foreign record name.
  - `acceptanceStatusMeetings` string
  - `acceptanceStatusCalls` string
  - `teamsIds` string[], nullable — IDs of records of the Team type.
  - `teamsNames` object, nullable — An {ID => record name} map.
  - `campaignId` string, nullable — An ID of the record of the Campaign type.
  - `campaignName` string, nullable — A foreign record name.
  - `createdAccountId` string, nullable — An ID of the record of the Account type.
  - `createdAccountName` string, nullable — A foreign record name.
  - `createdContactId` string, nullable — An ID of the record of the Contact type.
  - `createdContactName` string, nullable — A foreign record name.
  - `createdOpportunityId` string, nullable — An ID of the record of the Opportunity type.
  - `createdOpportunityName` string, nullable — A foreign record name.
  - `targetListsIds` string[], nullable — IDs of records of the TargetList type.
  - `targetListsNames` object, nullable — An {ID => record name} map.
  - `targetListId` string, nullable
  - `targetListName` string, nullable — A foreign record name.
  - `originalEmailId` string, nullable
  - `originalEmailName` string, nullable — A foreign record name.
  - `middleName` string, nullable — A one-line string.
  - `emailAddressIsOptedOut` boolean
  - `emailAddressIsInvalid` boolean
  - `phoneNumberIsOptedOut` boolean
  - `phoneNumberIsInvalid` boolean
  - `streamUpdatedAt` string, nullable — A timestamp in UTC.

## Other responses

- `400` — Bad request. Might be a validation error. Check logs for details.
- `403` — Forbidden. Might be an access control error. Check logs for details.
- `409` — Conflict. May be a possible duplicate. Use X-Skip-Duplicate-Check to skip check.

---

[API](https://skmtc.net/espocrm/apis/espocrm-api.md) · [All operations](https://skmtc.net/espocrm/apis/espocrm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/espocrm/espocrm-api/revisions/6622dabfccd3/schema)