Skip to main content
POST
Create a lead (website forms, n8n, Make)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
Required string length: 1 - 120
company
string
Maximum string length: 200
phone
string
Maximum string length: 40
email
string
source
enum<string>
default:api
Available options:
website,
api,
whatsapp,
sms,
referral,
manual,
meta_ads,
google_ads,
booking
expectedValueAgorot
integer
Required range: 0 <= x <= 9007199254740991
followUpAt
Pattern: ^\d{4}-\d{2}-\d{2}$
notes
string
Maximum string length: 5000
stage
string
Maximum string length: 60
customFields
object

Response

OK

id
string
required
Minimum string length: 1
name
string
required
company
string | null
required
taxId
string | null
required
phone
string | null
required
email
string | null
required
source
enum<string>
required
Available options:
website,
api,
whatsapp,
sms,
referral,
manual,
meta_ads,
google_ads,
booking
stage
object
required
expectedValueAgorot
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
followUpAt
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
owner
object | null
required
notes
string | null
required
status
enum<string>
required
Available options:
open,
won,
lost
lostReason
string | null
required
wonAt
string | null
required
lostAt
string | null
required
convertedClientId
string | null
required
Minimum string length: 1
sourceDetail
string | null
required
score
integer
default:0
required
Required range: 0 <= x <= 100
scoreBand
enum<string>
default:cold
required
Available options:
hot,
warm,
cold
wonReasonCode
enum<string> | null
required
Available options:
price,
quality,
portfolio,
referral,
speed,
relationship,
other
wonReason
string | null
required
lostReasonCode
enum<string> | null
required
Available options:
price,
budget,
competitor,
timing,
no_response,
not_fit,
other
customFields
object
required
createdAt
string
required
updatedAt
string
required