Create Leads in Bulk

Lets you create up to 50 leads in a single API call.

Pass as many lead fields (including custom fields) as you want but be sure to pass at least one of these for each lead –

  • FirstName
  • LastName
  • EmailAddress*
  • Phone Number*

* These fields are unique in LeadSquared by default so it’s recommended to pass at least one of them while creating a lead. If you want to change the unique fields of your leads navigate to My Account>Settings>Customization>Lead Fields and click the wheel icon beside a lead field to mark or remove uniqueness.

Note: If you want to create one lead at a time, use the Create Lead API.

API URL

POST
https://{host}/v2/LeadManagement.svc/Lead/Bulk/Create?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

[
   [
      {
         "Attribute":"EmailAddress",
         "Value":"king@myleadsquared.com"
      },
      {
         "Attribute":"FirstName",
         "Value":"Martin Luther"
      },
      {
         "Attribute":"LastName",
         "Value":"King"
      },
      {
         "Attribute":"Phone",
         "Value":"8888888888"
      },
      {
         "Attribute":"mx_City",
         "Value":"New York"
      },
      {
         "Attribute":"mx_KYC",
         "Value":"",
         "Fields":[
            {
               "Attribute":"Status",
               "Value":"Pending"
            },
            {
               "Attribute":"mx_CustomObject_1",
               "Value":"XYZ12345.png"
            },
            {
               "Attribute":"mx_CustomObject_2",
               "Value":"864563"
            }
         ]
      }
   ],
   [
      {
         "Attribute":"EmailAddress",
         "Value":"mkgandhi@myleadsquared.com"
      },
      {
         "Attribute":"FirstName",
         "Value":"Mahatma"
      },
      {
         "Attribute":"LastName",
         "Value":"Gandhi"
      },
      {
         "Attribute":"Phone",
         "Value":"8888888888"
      },
      {
         "Attribute":"mx_City",
         "Value":"Sabarmati"
      },
      {
         "Attribute":"mx_KYC",
         "Value":"",
         "Fields":[
            {
               "Attribute":"Status",
               "Value":"Pending"
            },
            {
               "Attribute":"mx_CustomObject_1",
               "Value":"XYZ12345.png"
            },
            {
               "Attribute":"mx_CustomObject_2",
               "Value":"864563"
            }
         ]
      }
   ]
]

JSON Properties

Parameter Description
Attribute

Pass as many lead fields (including custom fields). You must pass at least one unique field (e.g. email address or phone).

You can also pass custom field sets.

Note: You must pass the schema name of the field.
Value

The value of the specified attribute.

For custom field sets, you may pass an optional “Fields” array, containing attribute-value pairs for CFS fields. You must pass the schema name of the custom object fields in the attribute parameters.

Response

200 OK

Content-Type: application/json

[
    {
        "RowNumber": 1,
        "LeadId": "72f6999d-951f-45fc-984c-97e978ed3bc2",
        "LeadCreated": true
    },
    {
        "RowNumber": 2,
        "LeadId": "f666c7c8-fd62-4198-aa2e-8bd3b791bc0c",
        "LeadCreated": true
    }
]

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.
401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.
400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.
429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.