Capture Leads (Async)
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Captures leads from all sources. Functionality is the same as the synchronous Capture Leads 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.Content-Typeisapplication-json. - 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 Capture Leads Metrics API.
Note: The request body is identical to the synchronous Capture Leads API.
API URL
URL
POST
https://{async-host}/lead/capture?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
[
{
"Attribute":"FirstName",
"Value":"Bret"
},
{
"Attribute":"LastName",
"Value":"Lee"
},
{
"Attribute":"EmailAddress",
"Value":"bret.lee@australia.com"
},
{
"Attribute":"Phone",
"Value":"8888888888"
},
{
"Attribute":"ProspectID",
"Value":"xxxxxxxx-d168-xxxx-9f8b-xxxx97xxxxxx"
},
{
"Attribute":"SearchBy",
"Value":"Phone"
}
]
Request Parameters
| Parameter | Description |
|---|---|
| Attribute | Schema name of the Lead field. To get Schema name for all Lead fields use LeadsMetaData API. |
| Value | Value assigned to the given attribute. |
Response
200 OK
Content-Type: application/json
{
"Status":"Request accepted. Please use below request id to check the status",
"RequestID":"8eca6fa6-262c-43eb-8cfe-6e3325e2dc73"
}
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. |
