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

Authorizations

Authorization
string
header
required

Leadping source key for lead ingestion endpoints only using the Authorization header. Example: "Authorization: Bearer lp_src_...".

Body

The common lead fields submitted by the external system.

Defines the fields clients can send when working with lead intake.

idempotencyKey
null | string

Stable delivery key reused when retrying the same lead submission to this source.

firstName
null | string

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

lastName
null | string

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

email
null | string<email>

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

phone
null | string

Contact phone number. Use E.164 with a leading + for international numbers.

phoneType
null | string

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

dateOfBirth
null | string<date>

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

birthDate
null | string<date>

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

address1
null | string

First street address line submitted by the lead intake source.

address2
null | string

Second street address line submitted by the lead intake source.

city
null | string

City for the lead or organization postal address.

state
null | string

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

zip
null | string

ZIP code submitted by the lead intake source.

postalCode
null | string

Postal code for the lead or organization address.

gender
null | string

Lead gender supplied by intake sources and normalized when possible.

subId
null | string

Affiliate or publisher sub ID captured for lead attribution.

sellerLeadId
null | string

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

sellerLeadIdentifier
null | string

Alternate seller-provided lead identifier used during intake normalization.

directPostPrice
null | number<double>

Alias for price. When both are supplied, their amounts must agree.

price
null | number<double>

Lead price or transaction price supplied to the Leadping API.

utmSource
null | string

UTM source parameter captured for lead attribution reporting.

utmMedium
null | string

UTM medium parameter captured for lead attribution reporting.

utmCampaign
null | string

UTM campaign parameter captured for lead attribution reporting.

utmTerm
null | string

UTM term parameter captured for lead attribution reporting.

utmContent
null | string

UTM content parameter captured for lead attribution reporting.

product
null | string

Product or offer associated with the lead or source.

vertical
null | string

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

referrer
null | string

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

landingPage
null | string

Landing page URL where the lead submitted their information.

Certificate URL used as proof of consumer consent.

The provider responsible for a lead's consent certificate.

Available options:
TrustedForm,
Leadping,
Other

Explicitly attests to SMS consent when consentCertificateType is Other. Allows manual texts only.

externalId
null | string

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

sourceMetadata
null | object

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.

inquiry
object | null

The service or purchase requested by a lead.

company
object | null

Business represented by a lead contact.

serviceAddress
object | null

Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.

contactPreferences
object | null

Preferred contact language, channel, and callback windows; does not grant consent.

customFields
null | object

Industry-specific JSON scalar or scalar-array answers; keys are stable field identifiers.

profile
object | null

Public Leadping API schema for lead demographic profile data.

country
null | string

ISO 3166-1 alpha-2 contact address country code.

timeZoneId
null | string

Contact time zone identifier.

pubId
null | string

Publisher identifier.

capturedAt
null | string<date-time>

Original source capture timestamp.

captureIpAddress
null | string

Original visitor IP as reported by the source.

captureUserAgent
null | string

Original visitor user agent as reported by the source.

currency
null | string

ISO 4217 acquisition price currency.

Response

The lead response was created successfully.

Describes lead data returned by Leadping.

isDemo
boolean
assignedToUserId
null | string

Leadping user currently responsible for this lead, or null when it is in the unassigned queue.

assignedTo
object | null

Provides a compact API reference to another resource using its stable identifier and human-readable display name.

metadata
object

Public Leadping API schema for lead attribution metadata data.

contact
object

Public Leadping API schema for lead contact profile data.

phoneIdentity
object | null

Describes Leadping's canonical identity for a phone number, including normalization, carrier, line type, reputation, and lookup history.

profile
object | null

Public Leadping API schema for lead demographic profile data.

inquiry
object | null

The service or purchase requested by a lead.

company
object | null

Business represented by a lead contact.

serviceAddress
object | null

Describes a physical or mailing address using international locality, administrative-area, postal-code, and country fields.

contactPreferences
object | null

Preferred contact language, channel, and callback windows; does not grant consent.

customFields
null | object

Industry-specific JSON scalar or scalar-array answers; keys are stable field identifiers.

enabled
boolean

Whether the lead is enabled.

deletedAt
null | string<date-time>

UTC timestamp when this lead was soft deleted.

deletedByUserId
null | string

User ID of the person who soft deleted this lead.

archivedAt
null | string<date-time>

UTC timestamp when this record was archived.

archivedByUserId
null | string

User ID of the person who archived this record.

archiveReason
null | enum<integer>

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

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

Optional note explaining why the lead was archived.

isArchived
boolean

Indicates whether the lead has been archived in Leadping.

currentLeadStatus
object | null

Summary schema for Leadping API current lead status change summary data used in dashboards and reports.

processingStatus
null | enum<string>

Defines the asynchronous verification and enrichment lifecycle for a lead.

Available options:
Quarantined,
Verifying,
Validating,
Enriching,
Ready,
Invalid,
Failed
processingStatusReason
null | string

Explanation when asynchronous lead processing is blocked or fails.

processingStatusChangedAt
null | string<date-time>

UTC timestamp when the processing stage last changed.

tags
object[]

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

id
string

Stable unique identifier of the resource.

createdAt
string<date-time>

UTC timestamp when the resource was created.

modifiedAt
null | string<date-time>

UTC timestamp when the resource was last modified, or null when it has not been updated.