Skip to main content
POST
/
leads
Creates a lead externally.
curl --request POST \
  --url https://api.leadping.ai/leads \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "metadata": {
    "utmSource": "<string>",
    "utmMedium": "<string>",
    "utmCampaign": "<string>",
    "referrer": "<string>",
    "landingPage": "<string>",
    "subId": "<string>",
    "pubId": "<string>",
    "ipAddress": "<string>",
    "userAgent": "<string>",
    "externalId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "price": 123,
    "trustedFormUrl": "<string>",
    "userId": "<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>"
    },
    "phone": {
      "number": "<string>",
      "lookup": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z",
        "number": "<string>",
        "isValid": true,
        "lineType": "Wireline",
        "carrierType": "FixedLine",
        "location": {
          "location": "<string>",
          "state": "<string>",
          "countryCode": "<string>"
        }
      }
    },
    "email": "<string>"
  },
  "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
  }
}'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z",
  "metadata": {
    "utmSource": "<string>",
    "utmMedium": "<string>",
    "utmCampaign": "<string>",
    "referrer": "<string>",
    "landingPage": "<string>",
    "subId": "<string>",
    "pubId": "<string>",
    "ipAddress": "<string>",
    "userAgent": "<string>",
    "externalId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "price": 123,
    "trustedFormUrl": "<string>",
    "userId": "<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>"
    },
    "phone": {
      "number": "<string>",
      "lookup": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z",
        "number": "<string>",
        "isValid": true,
        "lineType": "Wireline",
        "carrierType": "FixedLine",
        "location": {
          "location": "<string>",
          "state": "<string>",
          "countryCode": "<string>"
        }
      }
    },
    "email": "<string>"
  },
  "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
  }
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. (i.e. "Bearer 1234abcdef")

Body

application/json

The lead data submitted by the external system.

​
id
string | null
​
metadata
object

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

​
contact
object

Represents the primary contact details for a lead, including name, address, phone, and email.

​
customer
object

Represents a lead prospect's profile, containing demographic and financial information.

Response

Lead was successfully created.

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

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

​
contact
object

Represents the primary contact details for a lead, including name, address, phone, and email.

​
customer
object

Represents a lead prospect's profile, containing demographic and financial information.

⌘I