API Reference

Add prospective lead api. This will create a new prospective lead with an immediate response.

Lead Create Request

Request body should contain all Required fields. If you do not have a value for the required field, please pass an empty/blank value

Kindly provide at least 5 seconds for request timeout

Duplicate Request Validations:

Duplicate leads will be verified and rejected when matching ref_id is found for a prospective lead

Business Rule Validations

The following business rules are applied before the lead is committed:

  1. If all the following fields are empty/blank, the request will be rejected
    1. first_name
    2. last_name

The fields listed below can be added to the request.

ssn
dob
cc_first_name
cc_middle_name
cc_last_name
cc_dob
cc_ssn
cc_phone
cc_email
tcpa
owner
src_alias
src_detail
utm_src
debt_amount
utm_campaign
utm_keyw
utm_medium
lang
note
mailer_pin
mailer_id
mailed_on
monthly_income
cc_monthly_income
housing_rent
housing_insurance
property_tax
utilities
phone_cost
internet_cost
groceries
child_care
dry_cleaning
auto_payment
fuel_cost
auto_insurance
life_insurance
medical_insurance
medicine_expense
disposition
lead_status

On conversion to a Lead, these field values will be mapped to respective fields in Lead.

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!