Skip to main content
POST
/
leads
Create a new lead
curl --request POST \
  --url https://api.heffl.com/api/v1/leads \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "mobile": "<string>",
  "secondaryMobile": "<string>",
  "email": "[email protected]",
  "title": "<string>",
  "value": 123,
  "source": "<string>",
  "website": "<unknown>",
  "cf_": "<unknown>"
}
'
{
  "number": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "title": "<string>",
  "email": "[email protected]",
  "mobile": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Body

application/json
​
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> | null
​
title
string

Job title or position

​
value
number

Expected deal value or amount

​
source
string

Lead source (e.g., 'Website', 'Referral', 'Social Media'). Creates a new source if it doesn't exist.

​
website
any | null

Company website URL

​
cf_
any | null

Custom fields, that start with cf_

​
{key}
any

Response

200 - application/json

OK

​
number
string
required

Auto-generated lead number

​
id
string
required

Lead ID

​
createdAt
string<date-time>
required

When the lead was created

​
name
string
required

Full name

​
title
string
required

Job title

​
email
string<email> | null

Email address

​
mobile
string | null

Mobile phone number with country code