v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

Leads

Create Lead

The Create lead API request enables you to create leads in mass. You should add all the details in the request body.

Request Body

The request body should be in the raw format.
The payload should include an array of objects, where each object represents a lead with various properties such as first_name, last_name, phone, address, purchase details, email, birthdate, loan_amount, and customFields.

Response

The response will be an array of objects, each containing information about the lead added. The objects will include properties like id, lead_file_id, api_user_id, first_name, last_name, phone, address, purchase details, email, birthdate, loan_amount, remote_adapter_id, hlr, and customFields.

post/leads

Request body

address1string

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:address2","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:birthdate","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:city","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:email","oasType":"schema","type":"unknown","example":null,"nullable":true}

first_namestring

last_namestring

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:lat","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:lng","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:loan_amount","oasType":"schema","type":"unknown","example":null,"nullable":true}

original_identifierstring

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:purchase_amount","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:purchase_card_digits","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:purchase_card_name","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:purchase_card_type","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:purchase_date","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:purchase_product_name","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:purchase_site","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:state","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:support_site","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:timezone","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/leads:post:requestBody:content:application/json:schema:items:properties:zip","oasType":"schema","type":"unknown","example":null,"nullable":true}

Example request

[
  {
    "address1": "eftesh",
    "address2": null,
    "birthdate": null,
    "city": null,
    "customFields": {
      "custom_string": "123qwe",
      "field2": "field value"
    },
    "email": null,
    "first_name": "Vasya55",
    "last_name": "Smith",
    "lat": null,
    "lng": null,
    "loan_amount": null,
    "original_identifier": "1",
    "purchase_amount": null,
    "purchase_card_digits": null,
    "purchase_card_name": null,
    "purchase_card_type": null,
    "purchase_date": null,
    "purchase_product_name": null,
    "purchase_site": null,
    "state": null,
    "support_site": null,
    "timezone": null,
    "zip": null
  }
]

Response

Successful operation

Example response

{
  "leads": [
    {
      "address1": "eftesh",
      "address2": null,
      "api_user_id": "1",
      "birthdate": null,
      "city": null,
      "country_id": null,
      "created_at": "2022-08-16 08:22:12",
      "customFields": {
        "custom_string": "123qwe",
        "my_test": "www"
      },
      "duplicate_of": null,
      "email": null,
      "first_name": "Vasya55",
      "hlr": "0",
      "id": "49",
      "is_deleted": "0",
      "is_do_not_call": "0",
      "is_error_msg": null,
      "is_locked": "0",
      "last_name": "Smith",
      "lat": null,
      "lead_file_id": null,
      "lng": null,
      "loan_amount": null,
      "locked_user_id": null,
      "original_identifier": "1",
      "parsing_state": "0",
      "phone": "****21123",
      "phone2": null,
      "phone_normalized": null,
      "phone_normalized2": null,
      "purchase_amount": "0",
      "purchase_card_digits": "",
      "purchase_card_name": null,
      "purchase_card_type": null,
      "purchase_date": "1970-01-01 00:00:00",
      "purchase_product_name": null,
      "purchase_site": null,
      "remote_adapter_id": "0",
      "state": null,
      "support_site": null,
      "timezone": null,
      "timezone_id": null,
      "updated_at": null,
      "zip": null
    }
  ]
}