---
title: "Create Lead"
method: POST
path: "/leads"
tags: ["Leads"]
---

# Create Lead

`POST /leads`

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.

## Request body

- object[]
  - `address1` string
  - `address2` unknown
  - `birthdate` unknown
  - `city` unknown
  - `customFields` object
    - `custom_string` string
    - `field2` string
  - `email` unknown
  - `first_name` string
  - `last_name` string
  - `lat` unknown
  - `lng` unknown
  - `loan_amount` unknown
  - `original_identifier` string
  - `purchase_amount` unknown
  - `purchase_card_digits` unknown
  - `purchase_card_name` unknown
  - `purchase_card_type` unknown
  - `purchase_date` unknown
  - `purchase_product_name` unknown
  - `purchase_site` unknown
  - `state` unknown
  - `support_site` unknown
  - `timezone` unknown
  - `zip` unknown

## Response `201`

Successful operation

- object
  - `leads` object[]
    - `address1` string
    - `address2` unknown
    - `api_user_id` string
    - `birthdate` unknown
    - `city` unknown
    - `country_id` unknown
    - `created_at` string
    - `customFields` object
      - `custom_string` string
      - `my_test` string
    - `duplicate_of` unknown
    - `email` unknown
    - `first_name` string
    - `hlr` string
    - `id` string
    - `is_deleted` string
    - `is_do_not_call` string
    - `is_error_msg` unknown
    - `is_locked` string
    - `last_name` string
    - `lat` unknown
    - `lead_file_id` unknown
    - `lng` unknown
    - `loan_amount` unknown
    - `locked_user_id` unknown
    - `original_identifier` string
    - `parsing_state` string
    - `phone` string
    - `phone2` unknown
    - `phone_normalized` unknown
    - `phone_normalized2` unknown
    - `purchase_amount` string
    - `purchase_card_digits` string
    - `purchase_card_name` unknown
    - `purchase_card_type` unknown
    - `purchase_date` string
    - `purchase_product_name` unknown
    - `purchase_site` unknown
    - `remote_adapter_id` string
    - `state` unknown
    - `support_site` unknown
    - `timezone` unknown
    - `timezone_id` unknown
    - `updated_at` unknown
    - `zip` unknown

## Other responses

- `503` — Error

---

[API](https://skmtc.net/commpeak/apis/dialer-api-v2-0-1.md) · [All operations](https://skmtc.net/commpeak/apis/dialer-api-v2-0-1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/commpeak/dialer-api-v2-0-1/versions/eacecf960bb6/schema)