Create lead

post

https://{apiHost}/api/v2/public/leads

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Lead input for create/update operations

firstName

string

Contact person's first name

lastName

string

Contact person's last name

phoneNumber

string

Phone number (will be normalized to digits only)

string

Email address (will be normalized to lowercase)

relationship

string

Relationship to prospective client

description

string

Lead description/notes

locationId

string

required

Geographic location ID

status

string

Lead status

closingStatus

string

Closing status

closingReasonId

string

Attribute ID for closing reason. Use GET /config/attributes?type=closingReason to get options.

qualified

string

Qualification status

stageId

string

Attribute ID for pipeline stage. Use GET /config/attributes?type=stage to get options.

phaseId

string

Attribute ID for workflow phase. Use GET /config/attributes?type=leadPhase to get options.

externalId

string

External system identifier

source

object

Lead source

managedById

string

ID of user managing this lead

201Lead created

400Request validation failed