Create a Lead

Lets you create a new lead.

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

  • FirstName
  • LastName
  • EmailAddress*
  • Phone*

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

API URL

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

Request

JSON Body/Payload

Content-Type: application/json

[
    {"Attribute": "EmailAddress", "Value": "john.smith@example.com"},
    {"Attribute": "FirstName", "Value": "John"},
    {"Attribute": "LastName", "Value": "Smith"},
    {"Attribute": "Phone", "Value": "8888888888"},
    {"Attribute": "mx_City", "Value": "Bangalore"}
]

JSON Properties

Parameter Description
EmailAddress

The lead’s email address.

FirstName

The lead’s first name.

LastName

The lead’s last name.

Phone

The lead’s phone number.

mx_City

Custom field for the lead’s city.

Response

200 OK

Content-Type: application/json

{
    "Status":"Success",
    "Message":{
               "Id":"xxxxxxxx-Lead-Idxx-xxxx-xxxxxxxxxxxx"
              }
}

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.