Create a Lead and Activity (Async)
Creates a new lead and activity. Functionality is the same as the synchronous Create a Lead and Activity API, with the following differences –
- API host is different, see Async API.
- An additional
x-api-keymust be passed in the header, see Async API. If this header is not passed, the request will not be accepted. - Returns a
RequestIdparameter. This must be passed in the Status API to get the status of the request. - To get metrics for this Async API, see Get Create Lead and Activity Metrics API.
Note:
- The request body is identical to the synchronous Create a Lead and Activity API.
- The supported DateTime format is UTC (YYYY-MM-DD HH:MM:SS).
API URL
URL
POST
https://{async-host}/activity/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 in UTC (YYYY-MM-DD HH:MM:SS). |
| 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":"Request accepted. Please use below request id to check the status",
"RequestID":" 571dfc10-d3e6-4511-8d33-c7a7ad8c236c"
}
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. |
