Skip to main content
POST
Create a lead record from intake payload

Query Parameters

sourceKey
string

The Leadping source key supplied as a query string parameter, or omitted when supplied as Authorization: Bearer lp_src_...

Body

The common lead fields submitted by the external system.

Request schema for the Leadping API lead intake request, including the fields clients can send.

firstName
string | null

First name of the lead, user, or contact represented by this lead intake request.

lastName
string | null

Last name of the lead, user, or contact represented by this lead intake request.

email
string | null

Email address for the person represented by this lead intake request.

phone
string | null

Phone details for the lead, user, or business represented by this lead intake request.

phoneType
string | null

Source-provided phone type, such as mobile, landline, or VoIP, used during lead intake normalization.

dateOfBirth
string<date> | null

Lead date of birth supplied by intake sources and normalized into the lead profile.

birthDate
string<date> | null

Lead birth date used for demographic matching and insurance intake workflows.

address1
string | null

First street address line submitted by the lead intake source.

address2
string | null

Second street address line submitted by the lead intake source.

city
string | null

City for the lead or business postal address.

state
string | null

State, province, or region for the lead or business postal address.

zip
string | null

ZIP code submitted by the lead intake source.

postalCode
string | null

Postal code for the lead or business address.

gender
string | null

Lead gender supplied by intake sources and normalized when possible.

subId
string | null

Affiliate or publisher sub ID captured for lead attribution.

sellerLeadId
string | null

Seller-provided lead identifier used to deduplicate and reconcile lead delivery.

sellerLeadIdentifier
string | null

Alternate seller-provided lead identifier used during intake normalization.

directPostPrice
string<double> | null

Direct-post price supplied by the lead source during intake.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
price
string<double> | null

Lead price or transaction price supplied to the Leadping API.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
utmSource
string | null

UTM source parameter captured for lead attribution reporting.

utmMedium
string | null

UTM medium parameter captured for lead attribution reporting.

utmCampaign
string | null

UTM campaign parameter captured for lead attribution reporting.

utmTerm
string | null

UTM term parameter captured for lead attribution reporting.

utmContent
string | null

UTM content parameter captured for lead attribution reporting.

product
string | null

Product or offer associated with the lead or source.

vertical
string | null

Industry vertical used for lead routing, compliance review, and reporting.

referrer
string | null

Referring page or traffic source that sent the lead into Leadping.

landingPage
string | null

Landing page URL where the lead submitted their information.

trustedFormUrl
string | null

TrustedForm certificate URL used as proof of consumer consent.

externalId
string | null

External system identifier used to reconcile this lead intake request across integrations.

sourceMetadata
object | null

Source-provided key-value metadata retained for lead attribution and integration troubleshooting.

tagIds
string[]

Tag IDs assigned to or filtered against this lead.

tagNames
string[]

Tag names assigned to this lead when matching existing tags by name.

Response

The lead response was created successfully.

Response schema for the Leadping API lead response returned to authenticated clients.

metadata
object

Structured metadata used for attribution, integrations, and reporting on this lead response.

contact
object

Contact details for the lead or customer represented by this lead response.

phoneIdentity
object | null

Canonical phone identity and provider lookup details for this lead.

customer
object

Demographic profile details for the lead represented by this lead response.

enabled
boolean

Indicates whether this lead response is active and available in the Leadping API.

archivedAt
string<date-time> | null

UTC timestamp when this record was archived.

archivedByUserId
string | null

User ID of the person who archived this record.

archiveReason
enum<integer> | null

Defines why a lead was removed from the active working pipeline.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
archiveNote
string | null

Optional note explaining why the lead was archived.

isArchived
boolean

Indicates whether the lead has been archived in Leadping.

currentDisposition
object | null

Current disposition summary that describes the lead outcome.

tags
object[]

Tags currently attached to this lead, source, or record.

id
string

The unique identifier for the entity.

createdAt
string<date-time>

The date and time when the entity was created.

modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.