---
title: "Create a new lead"
method: POST
path: "/leads"
tags: ["Leads"]
---

# Create a new lead

`POST /leads`

## Request

- Base URL: `https://api.heffl.com/api/v1`
- URL: `https://api.heffl.com/api/v1/leads`
- Auth: API key in header `x-api-key`

Creates a new lead in your CRM. The lead will be assigned to the user associated with your API key.

## Request body

- object
  - `name` string, required: Lead's full name
  - `mobile` string: Mobile phone number with country code
  - `secondaryMobile` string: Secondary mobile phone number with country code
  - `email` string, email, nullable
  - `title` string: Job title or position
  - `value` number: Expected deal value or amount
  - `sourceId` string: Lead source public ID
  - `stageId` string: Lead stage public ID
  - `website` unknown

## Response `200`

OK

- object
  - `id` string, required: Lead public ID
  - `number` string, required: Auto-generated lead number
  - `name` string, required: Full name
  - `title` string, nullable: Job title
  - `email` string, nullable: Email address
  - `mobile` string, nullable: Mobile phone number
  - `secondaryMobile` string, nullable: Secondary mobile
  - `website` string, nullable: Website URL
  - `value` number, nullable: Expected value
  - `archived` boolean, required: Whether the lead is archived
  - `sourceId` string, nullable: Lead source public ID
  - `stageId` string, nullable: Lead stage public ID
  - `createdAt` string, date-time, required: When the lead was created
  - `customFields` object, nullable: Custom field values

---

[API](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1.md) · [All operations](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/heffl/apis/heffl-public-api-legacy-v1/revisions/9bdb229223a2?raw)