Add Lead

post

https://{subdomain}.relintex.net/ws/api/v1/lead

Version 2.0 of add lead api. This will create a new lead or reject duplicate leads with an immediate response.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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 using following rules:

When matching phone is found for an active lead
When matching email is found for an active lead
When matching ref_id is found for an active lead

Business Rule Validations

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

If ssn contains a value, it should be a valid ssn
If dob contains a value, it should be a valid dob
If phone contains a value, it should be a valid phone number format (10 digits)
If email contains a value, it should be a valid email format
If all the following fields are empty/blank, the request will be rejected
1. first_name
2. last_name
3. phone
4. email

Body Params

ref_id

string

required

Lead Reference ID (this will be used for further interactions between 2 systems). If an empty/blank value is passed, this will be populated with the cust_ref_id returned in response

first_name

string

required

Lead first name

middle_name

string

Lead middle name

last_name

string

required

Lead last name

marital_status

string

enum

Defaults to Single

Single,Married,Married/Domestic,Partner,Divorced,Widowed,Separated,Engaged,Other

dob

string

Date of Birth - format: MM/DD/YYYY

ssn

string

Social security number

phone

string

required

Contact number

string

Email address

address

string

required

Contact address

address2

string

Contact address line 2

city

string

required

City

state

string

required

State short code

zip

string

required

Address zip code

cc_first_name

string

Co Client First Name

cc_middle_name

string

Co Client Middle Name

cc_last_name

string

Co Client Last Name

cc_dob

string

Co Client date of birth - format: MM/DD/YYYY

cc_ssn

string

Co Client Social security number

cc_phone

string

Co Client Phone

cc_email

string

Co Client Email

tcpa

string

enum

Defaults to none

TCPA Disclosure

Allowed:

owner

string

Owner

src_alias

string

Lead Source Alias

src_detail

string

Lead Source detail

utm_src

string

UTM Source

debt_amount

float

Defaults to 0

Estimated debt amount

utm_campaign

string

UTM Campaign

utm_keyw

string

UTM keyword

utm_medium

string

UTM Medium

lang

string

enum

Defaults to english

Language

Allowed:

note

string

Note

mailer_pin

string

Mailer PIN

mailer_id

string

Mailer ID

mailed_on

string

Mailed on

monthly_income

float

Defaults to 0

Client monthly income

cc_monthly_income

float

Defaults to 0

Co Client monthly income

housing_rent

float

Defaults to 0

Mortgage or Rent

housing_insurance

float

Defaults to 0

Mortgage or Renters Insurance

property_tax

float

Defaults to 0

Monthly Property Tax

utilities

float

Defaults to 0

Electric/Gas/Oil/Propane

phone_cost

float

Defaults to 0

Cell/home phone

internet_cost

float

Defaults to 0

Internet/Cable

groceries

float

Defaults to 0

Groceries

child_care

float

Defaults to 0

Child Care (clothes, sports, etc.)

child_support

float

Defaults to 0

Child Support/Alimony

dry_cleaning

float

Defaults to 0

Dry Cleaning/ Laundry

auto_payment

float

Defaults to 0

Auto Payment

fuel_cost

float

Defaults to 0

Auto Maintenance

auto_insurance

float

Defaults to 0

Auto Insurance

life_insurance

float

Defaults to 0

Life Insurance

medical_insurance

float

Defaults to 0

Medical Insurance

medicine_expense

float

Defaults to 0

Prescriptions

auto_maintenance

float

Defaults to 0

Auto Maintenance

storage_cost

float

Defaults to 0

Parking/Storage

public_transportation_cost

float

Defaults to 0

Public Transportation

dining_out_cost

float

Defaults to 0

Dining Out

water_sewer_trash

float

Defaults to 0

Water/Sewer/Trash

personal_care

float

Defaults to 0

Personal Care: Hair Cuts/Hair Care/Toiletries/Clothes

in_home_care

float

Defaults to 0

In Home Care

pet_care

float

Defaults to 0

Pet Care

co_pays

float

Defaults to 0

Deductibles/Co-Pays

disposition

string

Disposition slug

lead_status

string

Lead status slug

loan_amount

float

Defaults to 0

Loan Amount

employer

string

Employer

position

string

Position

alternate_phone

string

Alternate phone number if available

Responses

Lead Create Request

Duplicate Request Validations:

Business Rule Validations

200200

400400

401401

429429