latestOpenAPI 3.1.12026-07-268973189.3 KB

27006cfef4d8

Leads

Create a new lead

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

post/leads

Request body

namestring required

Lead's full name

mobilestring

Mobile phone number with country code

secondaryMobilestring

Secondary mobile phone number with country code

emailstring email nullable

titlestring

Job title or position

valuenumber

Expected deal value or amount

sourceIdstring

Lead source public ID

stageIdstring

Lead stage public ID

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:properties:website:anyOf","oasType":"schema","type":"unknown","description":"Company website URL","nullable":true}

Response

idstring required

Lead public ID

numberstring required

Auto-generated lead number

namestring required

Full name

titlestring nullable

Job title

emailstring nullable

Email address

mobilestring nullable

Mobile phone number

secondaryMobilestring nullable

Secondary mobile

websitestring nullable

Website URL

valuenumber nullable

Expected value

archivedboolean required

Whether the lead is archived

sourceIdstring nullable

Lead source public ID

stageIdstring nullable

Lead stage public ID

createdAtstring date-time required

When the lead was created

customFieldsobject nullable

Custom field values