API Reference

Version 2.0 of add lead api. This will create a new lead or reject duplicate leads 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 using following rules:

  1. When matching phone is found for an active lead
  2. When matching email is found for an active lead
  3. When matching ref_id is found for an active lead

Business Rule Validations

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

  1. If ssn contains a value, it should be a valid ssn
  2. If dob contains a value, it should be a valid dob
  3. If phone contains a value, it should be a valid phone number format (10 digits)
  4. If email contains a value, it should be a valid email format
  5. If all the following fields are empty/blank, the request will be rejected
    1. first_name
    2. last_name
    3. phone
    4. email
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!