Create a lead record from intake payload

curl --request POST \
  --url https://api.leadping.ai/leads/intake \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "Taylor",
  "lastName": "Morgan",
  "email": "taylor@example.com",
  "phone": "+13125550100",
  "utmSource": "paid-search",
  "utmCampaign": "summer-campaign",
  "landingPage": "https://example.com/request-a-quote",
  "externalId": "external-lead-123",
  "tagNames": [
    "website",
    "new-lead"
  ]
}
'

import requests

url = "https://api.leadping.ai/leads/intake"

payload = {
    "firstName": "Taylor",
    "lastName": "Morgan",
    "email": "taylor@example.com",
    "phone": "+13125550100",
    "utmSource": "paid-search",
    "utmCampaign": "summer-campaign",
    "landingPage": "https://example.com/request-a-quote",
    "externalId": "external-lead-123",
    "tagNames": ["website", "new-lead"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/leads/intake");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"firstName\": \"Taylor\",\n  \"lastName\": \"Morgan\",\n  \"email\": \"taylor@example.com\",\n  \"phone\": \"+13125550100\",\n  \"utmSource\": \"paid-search\",\n  \"utmCampaign\": \"summer-campaign\",\n  \"landingPage\": \"https://example.com/request-a-quote\",\n  \"externalId\": \"external-lead-123\",\n  \"tagNames\": [\n    \"website\",\n    \"new-lead\"\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

HttpResponse<String> response = Unirest.post("https://api.leadping.ai/leads/intake")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"Taylor\",\n  \"lastName\": \"Morgan\",\n  \"email\": \"taylor@example.com\",\n  \"phone\": \"+13125550100\",\n  \"utmSource\": \"paid-search\",\n  \"utmCampaign\": \"summer-campaign\",\n  \"landingPage\": \"https://example.com/request-a-quote\",\n  \"externalId\": \"external-lead-123\",\n  \"tagNames\": [\n    \"website\",\n    \"new-lead\"\n  ]\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: 'Taylor',
    lastName: 'Morgan',
    email: 'taylor@example.com',
    phone: '+13125550100',
    utmSource: 'paid-search',
    utmCampaign: 'summer-campaign',
    landingPage: 'https://example.com/request-a-quote',
    externalId: 'external-lead-123',
    tagNames: ['website', 'new-lead']
  })
};

fetch('https://api.leadping.ai/leads/intake', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/leads/intake"

	payload := strings.NewReader("{\n  \"firstName\": \"Taylor\",\n  \"lastName\": \"Morgan\",\n  \"email\": \"taylor@example.com\",\n  \"phone\": \"+13125550100\",\n  \"utmSource\": \"paid-search\",\n  \"utmCampaign\": \"summer-campaign\",\n  \"landingPage\": \"https://example.com/request-a-quote\",\n  \"externalId\": \"external-lead-123\",\n  \"tagNames\": [\n    \"website\",\n    \"new-lead\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/leads/intake",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => 'Taylor',
    'lastName' => 'Morgan',
    'email' => 'taylor@example.com',
    'phone' => '+13125550100',
    'utmSource' => 'paid-search',
    'utmCampaign' => 'summer-campaign',
    'landingPage' => 'https://example.com/request-a-quote',
    'externalId' => 'external-lead-123',
    'tagNames' => [
        'website',
        'new-lead'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "assignedToUserId": "<string>",
  "assignedTo": {
    "id": "<string>",
    "name": "<string>"
  },
  "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": 123,
    "directPostPrice": 123,
    "product": "<string>",
    "vertical": "<string>",
    "complianceStatus": "<string>",
    "complianceBlockedReason": "<string>",
    "sourceMetadata": {},
    "origin": "<string>",
    "importBatchId": "<string>",
    "isImported": true,
    "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>",
    "trustedFormCheckedAt": "2023-11-07T05:31:56Z",
    "userId": "<string>",
    "organizationId": "<string>"
  },
  "contact": {
    "firstName": "<string>",
    "lastName": "<string>",
    "streetAddress": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "province": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "additionalInfo": "<string>"
    },
    "coordinate": {
      "latitude": 123,
      "longitude": 123
    },
    "timeZoneId": "<string>",
    "phone": {
      "phoneIdentityId": "<string>",
      "number": "<string>",
      "type": "<string>"
    },
    "email": "jsmith@example.com",
    "avatarUrl": "<string>"
  },
  "phoneIdentity": {
    "number": "<string>",
    "lookup": {
      "number": "<string>",
      "nationalFormat": "<string>",
      "recordType": "<string>",
      "fraud": "<string>",
      "isValid": true,
      "lineType": "Wireline",
      "carrier": {
        "mobileCountryCode": "<string>",
        "mobileNetworkCode": "<string>",
        "name": "<string>",
        "normalizedCarrier": "<string>",
        "type": "FixedLine",
        "errorCode": "<string>"
      },
      "callerName": {
        "name": "<string>",
        "errorCode": "<string>"
      },
      "portability": {
        "alternativeSpid": "<string>",
        "alternativeCarrierName": "<string>",
        "alternativeCarrierType": "<string>",
        "city": "<string>",
        "lineType": "<string>",
        "localRoutingNumber": "<string>",
        "operatingCompanyNumber": "<string>",
        "portedDate": "<string>",
        "portedStatus": "<string>",
        "spid": "<string>",
        "carrierName": "<string>",
        "carrierType": "<string>",
        "state": "<string>"
      },
      "location": {
        "location": "<string>",
        "state": "<string>",
        "canonicalCity": "<string>",
        "canonicalState": "<string>",
        "countryCode": "<string>",
        "coordinate": {
          "latitude": 123,
          "longitude": 123
        },
        "coordinateSource": {
          "method": "<string>",
          "query": "<string>"
        },
        "timeZoneId": "<string>",
        "timeZoneSource": {
          "method": "<string>",
          "query": "<string>"
        }
      },
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "modifiedAt": "2023-11-07T05:31:56Z"
    },
    "providerEnrichment": {
      "provider": "<string>",
      "lookupType": "<string>",
      "schemaVersion": 123,
      "retrievedAt": "2023-11-07T05:31:56Z",
      "rawRecordJson": "<string>"
    },
    "lastEnrichedAt": "2023-11-07T05:31:56Z",
    "lookupActions": [
      {
        "id": "<string>",
        "type": "validation",
        "provider": "<string>",
        "status": "succeeded",
        "occurredAt": "2023-11-07T05:31:56Z",
        "providerCostAmount": 123,
        "providerPricingVersion": "<string>"
      }
    ],
    "name": "<string>",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "modifiedAt": "2023-11-07T05:31:56Z"
  },
  "customer": {
    "gender": "M",
    "height": 123,
    "weight": 123,
    "birthDate": "2023-12-25",
    "maritalStatus": "Married",
    "income": 123,
    "isHomeowner": true,
    "monthsAtResidence": 123,
    "creditScore": 123,
    "hasBankruptcy": true,
    "employmentType": "Employed",
    "numberOfDependents": 123,
    "hasMedicalCondition": true
  },
  "enabled": true,
  "deletedAt": "2023-11-07T05:31:56Z",
  "deletedByUserId": "<string>",
  "archivedAt": "2023-11-07T05:31:56Z",
  "archivedByUserId": "<string>",
  "archiveReason": 0,
  "archiveNote": "<string>",
  "isArchived": true,
  "currentLeadStatus": {
    "id": "<string>",
    "category": "Open",
    "outcome": "<string>",
    "displayName": "<string>",
    "changedAt": "2023-11-07T05:31:56Z",
    "changedByUserId": "<string>",
    "changedByAutomationId": "<string>",
    "source": "User"
  },
  "processingStatus": "Quarantined",
  "processingStatusReason": "<string>",
  "processingStatusChangedAt": "2023-11-07T05:31:56Z",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "normalizedName": "<string>",
      "color": "<string>"
    }
  ],
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

POST

leads

intake

Create a lead record from intake payload

curl --request POST \
  --url https://api.leadping.ai/leads/intake \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "Taylor",
  "lastName": "Morgan",
  "email": "taylor@example.com",
  "phone": "+13125550100",
  "utmSource": "paid-search",
  "utmCampaign": "summer-campaign",
  "landingPage": "https://example.com/request-a-quote",
  "externalId": "external-lead-123",
  "tagNames": [
    "website",
    "new-lead"
  ]
}
'

import requests

url = "https://api.leadping.ai/leads/intake"

payload = {
    "firstName": "Taylor",
    "lastName": "Morgan",
    "email": "taylor@example.com",
    "phone": "+13125550100",
    "utmSource": "paid-search",
    "utmCampaign": "summer-campaign",
    "landingPage": "https://example.com/request-a-quote",
    "externalId": "external-lead-123",
    "tagNames": ["website", "new-lead"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/leads/intake");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"firstName\": \"Taylor\",\n  \"lastName\": \"Morgan\",\n  \"email\": \"taylor@example.com\",\n  \"phone\": \"+13125550100\",\n  \"utmSource\": \"paid-search\",\n  \"utmCampaign\": \"summer-campaign\",\n  \"landingPage\": \"https://example.com/request-a-quote\",\n  \"externalId\": \"external-lead-123\",\n  \"tagNames\": [\n    \"website\",\n    \"new-lead\"\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

HttpResponse<String> response = Unirest.post("https://api.leadping.ai/leads/intake")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"Taylor\",\n  \"lastName\": \"Morgan\",\n  \"email\": \"taylor@example.com\",\n  \"phone\": \"+13125550100\",\n  \"utmSource\": \"paid-search\",\n  \"utmCampaign\": \"summer-campaign\",\n  \"landingPage\": \"https://example.com/request-a-quote\",\n  \"externalId\": \"external-lead-123\",\n  \"tagNames\": [\n    \"website\",\n    \"new-lead\"\n  ]\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: 'Taylor',
    lastName: 'Morgan',
    email: 'taylor@example.com',
    phone: '+13125550100',
    utmSource: 'paid-search',
    utmCampaign: 'summer-campaign',
    landingPage: 'https://example.com/request-a-quote',
    externalId: 'external-lead-123',
    tagNames: ['website', 'new-lead']
  })
};

fetch('https://api.leadping.ai/leads/intake', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/leads/intake"

	payload := strings.NewReader("{\n  \"firstName\": \"Taylor\",\n  \"lastName\": \"Morgan\",\n  \"email\": \"taylor@example.com\",\n  \"phone\": \"+13125550100\",\n  \"utmSource\": \"paid-search\",\n  \"utmCampaign\": \"summer-campaign\",\n  \"landingPage\": \"https://example.com/request-a-quote\",\n  \"externalId\": \"external-lead-123\",\n  \"tagNames\": [\n    \"website\",\n    \"new-lead\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/leads/intake",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => 'Taylor',
    'lastName' => 'Morgan',
    'email' => 'taylor@example.com',
    'phone' => '+13125550100',
    'utmSource' => 'paid-search',
    'utmCampaign' => 'summer-campaign',
    'landingPage' => 'https://example.com/request-a-quote',
    'externalId' => 'external-lead-123',
    'tagNames' => [
        'website',
        'new-lead'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "assignedToUserId": "<string>",
  "assignedTo": {
    "id": "<string>",
    "name": "<string>"
  },
  "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": 123,
    "directPostPrice": 123,
    "product": "<string>",
    "vertical": "<string>",
    "complianceStatus": "<string>",
    "complianceBlockedReason": "<string>",
    "sourceMetadata": {},
    "origin": "<string>",
    "importBatchId": "<string>",
    "isImported": true,
    "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>",
    "trustedFormCheckedAt": "2023-11-07T05:31:56Z",
    "userId": "<string>",
    "organizationId": "<string>"
  },
  "contact": {
    "firstName": "<string>",
    "lastName": "<string>",
    "streetAddress": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "province": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "additionalInfo": "<string>"
    },
    "coordinate": {
      "latitude": 123,
      "longitude": 123
    },
    "timeZoneId": "<string>",
    "phone": {
      "phoneIdentityId": "<string>",
      "number": "<string>",
      "type": "<string>"
    },
    "email": "jsmith@example.com",
    "avatarUrl": "<string>"
  },
  "phoneIdentity": {
    "number": "<string>",
    "lookup": {
      "number": "<string>",
      "nationalFormat": "<string>",
      "recordType": "<string>",
      "fraud": "<string>",
      "isValid": true,
      "lineType": "Wireline",
      "carrier": {
        "mobileCountryCode": "<string>",
        "mobileNetworkCode": "<string>",
        "name": "<string>",
        "normalizedCarrier": "<string>",
        "type": "FixedLine",
        "errorCode": "<string>"
      },
      "callerName": {
        "name": "<string>",
        "errorCode": "<string>"
      },
      "portability": {
        "alternativeSpid": "<string>",
        "alternativeCarrierName": "<string>",
        "alternativeCarrierType": "<string>",
        "city": "<string>",
        "lineType": "<string>",
        "localRoutingNumber": "<string>",
        "operatingCompanyNumber": "<string>",
        "portedDate": "<string>",
        "portedStatus": "<string>",
        "spid": "<string>",
        "carrierName": "<string>",
        "carrierType": "<string>",
        "state": "<string>"
      },
      "location": {
        "location": "<string>",
        "state": "<string>",
        "canonicalCity": "<string>",
        "canonicalState": "<string>",
        "countryCode": "<string>",
        "coordinate": {
          "latitude": 123,
          "longitude": 123
        },
        "coordinateSource": {
          "method": "<string>",
          "query": "<string>"
        },
        "timeZoneId": "<string>",
        "timeZoneSource": {
          "method": "<string>",
          "query": "<string>"
        }
      },
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "modifiedAt": "2023-11-07T05:31:56Z"
    },
    "providerEnrichment": {
      "provider": "<string>",
      "lookupType": "<string>",
      "schemaVersion": 123,
      "retrievedAt": "2023-11-07T05:31:56Z",
      "rawRecordJson": "<string>"
    },
    "lastEnrichedAt": "2023-11-07T05:31:56Z",
    "lookupActions": [
      {
        "id": "<string>",
        "type": "validation",
        "provider": "<string>",
        "status": "succeeded",
        "occurredAt": "2023-11-07T05:31:56Z",
        "providerCostAmount": 123,
        "providerPricingVersion": "<string>"
      }
    ],
    "name": "<string>",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "modifiedAt": "2023-11-07T05:31:56Z"
  },
  "customer": {
    "gender": "M",
    "height": 123,
    "weight": 123,
    "birthDate": "2023-12-25",
    "maritalStatus": "Married",
    "income": 123,
    "isHomeowner": true,
    "monthsAtResidence": 123,
    "creditScore": 123,
    "hasBankruptcy": true,
    "employmentType": "Employed",
    "numberOfDependents": 123,
    "hasMedicalCondition": true
  },
  "enabled": true,
  "deletedAt": "2023-11-07T05:31:56Z",
  "deletedByUserId": "<string>",
  "archivedAt": "2023-11-07T05:31:56Z",
  "archivedByUserId": "<string>",
  "archiveReason": 0,
  "archiveNote": "<string>",
  "isArchived": true,
  "currentLeadStatus": {
    "id": "<string>",
    "category": "Open",
    "outcome": "<string>",
    "displayName": "<string>",
    "changedAt": "2023-11-07T05:31:56Z",
    "changedByUserId": "<string>",
    "changedByAutomationId": "<string>",
    "source": "User"
  },
  "processingStatus": "Quarantined",
  "processingStatusReason": "<string>",
  "processingStatusChangedAt": "2023-11-07T05:31:56Z",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "normalizedName": "<string>",
      "color": "<string>"
    }
  ],
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

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.

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.

null | string<email>

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

phone

null | string

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

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>

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

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.

trustedFormUrl

null | string<uri>

TrustedForm certificate URL used as proof of consumer consent.

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.

Show child attributes

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.

Describes lead data returned by Leadping.

assignedToUserId

null | string

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

assignedTo

object | null

Identifier and display name of the active organization member assigned to this lead.

Show child attributes

metadata

object

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

Show child attributes

contact

object

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

Show child attributes

phoneIdentity

object | null

Canonical phone identity and provider lookup details for this lead.

Show child attributes

customer

object

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

Show child attributes

enabled

boolean

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

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

Current lead status change summary that describes the lead outcome.

Show child attributes

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.

API Overview

Endpoints

Create a lead record from intake payload

Authorizations

Body

Response