Create a Lead
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
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.
Note: If Object Types are enabled on your account, the field (LeadType) value is set to OT_0 by default.
- You can change the
LeadTypefrom the default value (OT_0) to a custom value (OT_1, OT_2, and so on) only once. After you change it, you cannot update it again.
API URL
URL
POST
https://{host}/v2/LeadManagement.svc/Lead.Create?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
[
{
"Attribute": "EmailAddress",
"Value": "joe.pesci@example.com"
},
{
"Attribute": "FirstName",
"Value": "Joe"
},
{
"Attribute": "LastName",
"Value": "Pesci"
},
{
"Attribute": "Phone",
"Value": "8888888888"
},
{
"Attribute": "mx_City",
"Value": "New York City"
},
{
"Attribute": "mx_KYC",
"Value": "",
"Fields": [
{
"Attribute": "Status",
"Value": "Pending"
},
{
"Attribute": "mx_CustomObject_1",
"Value": "XYZ12345.png"
},
{
"Attribute": "mx_CustomObject_2",
"Value": "864563"
},
{
"Attribute": "LeadType",
"Value": "OT_1"
}
]
}
]
Request Parameters
| 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. |
| LeadType | If Object Types are enabled on your account, the LeadType value is OT_0 by default, and you can change it to a custom value (OT_1, OT_2, and so on) only once, after which you cannot update it again. This is optional. |
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Message": {
"Id": "cc3fef18-960b-4a60-98c0-af2ab61cee80"
}
}
HTTP Response Codes
| 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. |
