Skip to main content
POST
/
leads
/
intake
Creates a lead externally using a flat, source-authenticated intake payload.
curl --request POST \
  --url https://api.leadping.ai/leads/intake \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "phoneType": "<string>",
  "dateOfBirth": "2023-12-25",
  "birthDate": "2023-12-25",
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "postalCode": "<string>",
  "gender": "<string>",
  "subId": "<string>",
  "sellerLeadId": "<string>",
  "sellerLeadIdentifier": "<string>",
  "directPostPrice": "<string>",
  "price": "<string>",
  "utmSource": "<string>",
  "utmMedium": "<string>",
  "utmCampaign": "<string>",
  "utmTerm": "<string>",
  "utmContent": "<string>",
  "referrer": "<string>",
  "landingPage": "<string>",
  "trustedFormUrl": "<string>",
  "externalId": "<string>",
  "sourceMetadata": {}
}
'
{
  "metadata": {
    "trustedFormUrl": "<string>",
    "utmSource": "<string>",
    "utmMedium": "<string>",
    "utmCampaign": "<string>",
    "utmTerm": "<string>",
    "utmContent": "<string>",
    "referrer": "<string>",
    "landingPage": "<string>",
    "subId": "<string>",
    "pubId": "<string>",
    "ipAddress": "<string>",
    "userAgent": "<string>",
    "externalId": "<string>",
    "sellerLeadId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "price": "<string>",
    "directPostPrice": "<string>",
    "product": "<string>",
    "vertical": "<string>",
    "complianceStatus": "<string>",
    "complianceBlockedReason": "<string>",
    "sourceMetadata": {},
    "assignedPhoneNumberId": "<string>",
    "smsConsentStatus": "<string>",
    "smsOptedOut": true,
    "smsOptOutAt": "2023-11-07T05:31:56Z",
    "smsOptInAt": "2023-11-07T05:31:56Z",
    "smsHelpRequestedAt": "2023-11-07T05:31:56Z",
    "smsConsentPhoneNumber": "<string>",
    "userId": "<string>",
    "businessId": "<string>"
  },
  "contact": {
    "firstName": "<string>",
    "lastName": "<string>",
    "streetAddress": {},
    "phone": {},
    "email": "<string>"
  },
  "customer": {
    "gender": {},
    "height": "<string>",
    "weight": "<string>",
    "birthDate": "2023-12-25",
    "maritalStatus": {},
    "income": "<string>",
    "isHomeowner": true,
    "monthsAtResidence": "<string>",
    "creditScore": "<string>",
    "hasBankruptcy": true,
    "employmentType": {},
    "numberOfDependents": "<string>",
    "hasMedicalCondition": true
  },
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://leadping.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
X-Leadping-Source-Id
string
​
X-Leadping-Source-Key
string

Body

A token to cancel the operation.

Request payload for lead intake.

​
firstName
string | null

The first name value for this lead intake.

​
lastName
string | null

The date and time for the last name value on this lead intake.

​
email
string | null

The email address associated with this lead intake.

​
phone
string | null

The phone number associated with this lead intake.

​
phoneType
string | null

The phone type classification for this lead intake.

​
dateOfBirth
string<date> | null

The date and time for the date of birth value on this lead intake.

​
birthDate
string<date> | null

The date and time for the birth date value on this lead intake.

​
address1
string | null

The address1 value for this lead intake.

​
address2
string | null

The address2 value for this lead intake.

​
city
string | null

The city value for this lead intake.

​
state
string | null

The current state for this lead intake.

​
zip
string | null

The zip value for this lead intake.

​
postalCode
string | null

The postal code value for this lead intake.

​
gender
string | null

The gender value for this lead intake.

​
subId
string | null

The sub ID associated with this lead intake.

​
sellerLeadId
string | null

The seller lead ID associated with this lead intake.

​
sellerLeadIdentifier
string | null

The seller lead identifier value for this lead intake.

​
directPostPrice
string<double> | null

The direct post price value for this lead intake.

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

The monetary price for this lead intake.

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

The utm source value for this lead intake.

​
utmMedium
string | null

The utm medium value for this lead intake.

​
utmCampaign
string | null

The utm campaign value for this lead intake.

​
utmTerm
string | null

The utm term value for this lead intake.

​
utmContent
string | null

The utm content value for this lead intake.

​
referrer
string | null

The referrer value for this lead intake.

​
landingPage
string | null

The landing page value for this lead intake.

​
trustedFormUrl
string | null

The URL associated with this lead intake.

​
externalId
string | null

The external ID associated with this lead intake.

​
sourceMetadata
object

The source metadata key-value data carried with this lead intake; values must be safe to expose in API responses.

Response

The lead response was created successfully.

API response containing lead data returned to callers.

​
metadata
object

Metadata related to the origin, context, and attribution of a submitted lead.

​
contact
object

API DTO containing lead contact data used by Leadping API contracts.

​
customer
object

API DTO containing lead profile data used by Leadping API contracts.

​
id
string
​
createdAt
string<date-time>
​
modifiedAt
string<date-time> | null