Skip to main content
Leads

Create a lead

POST
/leads
Authorizationstringheaderrequired

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

Body

application/json
emailstring
Required string length: 1 - 255
follow_up_datestring
Pattern: ^\d{4}-\d{2}-\d{2}$
match_onenum<string>[]default:["phone","email"]
namestringrequired
Required string length: 1 - 255
notestring
Maximum string length: 20000
on_matchenum<string>default:merge
Available options: merge, error, overwrite
phonestring
Required string length: 1 - 40
priorityenum<string>
Available options: low, medium, high
projected_valuenumber
Required range: 0 <= x <= 10000000
propertyobject
service_typesstring[]
Maximum array length: 20
sourcestring
Maximum string length: 100
stagestring
Maximum string length: 100
tagsstring[]
Maximum array length: 20

Response

application/json

An existing lead matched and was updated

X-RateLimit-Limitintegerheader

The company's daily request limit.

X-RateLimit-Remainingintegerheader

Requests left in the current daily window.

X-RateLimit-Resetstringheader

When the daily window resets (UTC ISO timestamp).

X-RateLimit-Minute-Limitintegerheader

The company's per-minute request limit.

X-RateLimit-Minute-Remainingintegerheader

Requests left in the current minute.

X-RateLimit-Minute-Resetstringheader

When the minute window resets (UTC ISO timestamp).

archivedbooleanrequired
archived_atstring | nullrequired
assigned_tostring[]required
attachmentsobject[]required
created_atstringrequired
emailstring | nullrequired
follow_up_datestring | nullrequired
Pattern: ^\d{4}-\d{2}-\d{2}$
idstringrequired
matchedbooleanrequired
namestringrequired
noteobject | nullrequired
phonestring | nullrequired
priorityenum<string> | nullrequired
Available options: low, medium, high
projected_valuenumber | nullrequired
propertyobject | nullrequired
service_typesstring[]required
sourcestring | nullrequired
stagestring | nullrequired
tagsstring[]required
updated_atstringrequired