Create a Lead and Activity
Lets you create a new lead and post an activity on the lead at the same time.
- You can use the “SearchBy” parameter to specify a parameter to find the lead by (e.g., email address, phone number). If a lead exists with the specified value, it will be updated with any new lead attributes and activity details you pass.
- If a lead doesn’t exist based on the “SearchBy” parameter, a new lead will be created in your account.
- You have to pass the activity event code in the “ActivityEvent” parameter. You can also add values to custom activity fields by specifying the schema name (mx_Custom_1, mx_Custom_2, etc.)
- In order to get the list of all activity event codes, see Get List of Activity Types.
Note:
- To skip validating dropdown activity fields, pass an additional parameter
"ValidateDropDownOptions" : true. This is helpful if you’re passing drop-down values stored on Mavis DB. - Refer to the sample request to learn how to pass a custom field set to a lead and/or activitiy.
API URL
URL
POST
https://{host}/v2/ProspectActivity.svc/CreateCustom?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"LeadDetails":[
{
"Attribute":"EmailAddress",
"Value":"email@example.com"
},
{
"Attribute":"mx_City",
"Value":"Bangalore"
},
{
"Attribute":"mx_KYC",
"Value":"",
"Fields":[
{
"Attribute":"Status",
"Value":"Pending"
},
{
"Attribute":"mx_CustomObject_1",
"Value":"XYZ12345.png"
},
{
"Attribute":"mx_CustomObject_2",
"Value":"864563"
}
]
},
{
"Attribute":"SearchBy",
"Value":"EmailAddress"
}
],
"Activity":{
"ActivityEvent":105,
"ActivityNote":"Note for the activity",
"ActivityDateTime":"yyyy-MM-dd HH:mm:ss",
"Fields":[
{
"SchemaName":"mx_Custom_1",
"Value":"123"
},
{
"SchemaName":"mx_Custom_2",
"Value":"2016-07-07 10:55:00"
},
{
"Attribute":"mx_KYC",
"Value":"",
"Fields":[
{
"Attribute":"Status",
"Value":"Pending"
},
{
"Attribute":"mx_CustomObject_2",
"Value":"XYZ12345.png"
},
{
"Attribute":"mx_CustomObject_4",
"Value":"864563"
}
]
}
]
}
}
Request Parameters
| Parameter | Description |
|---|---|
| LeadDetails | Provide the lead fields using attribute-value pairs. You can use the “SearchBy” parameter to search for and update a particular lead based on email address, phone or unique fields in your account. 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. |
| ActivityEvent | The code of the activity. You can find activity codes in your LeadSquared account settings or by calling this API: Get List of Activity Types |
| ActivityNote | The description or notes associated with the activity. |
| ActivityDateTime | This is the date-time value of the activity that you want to post. |
| Fields | Pass attribute-value pairs for activity fields. 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
{
"Status": "Success",
"Message": {
"Id": "f0b1a207-7c72-11e5-a199-22000aa4133b"
}
}
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. |
