Capture Leads Status API
Returns the status of the lead capture request.
- Pass the
x-api-keyin the header, see Async API. - Pass the
RequestIdparameter returned by the Capture Leads (Async) API, in the query string.
Note: To get metrics for the Capture Leads (Async) API, see Get Capture Leads Metrics API.
The response JSON contains the following parameters –
| Parameter |
Description | Type | |
| RequestId | ID of the request. | String | |
| TaskStatus | Top-level parameter. Contains details of the task status. | Object | |
| TaskType | The task type related to the request. For example, “Lead Capture”. | String | |
| Status | Returned values are “In-Queue”, “FAILURE”, “ERROR”, “Success”. | String | |
| StatusReason | Text explaining the reason for the above status. If “Success”, then “Request was successfully completed” is returned; otherwise, error reason is returned. | String | |
| TaskCurrentStep | Current step the request is in. | Enum | |
| TaskLastStep | Previous step the request completed. | Enum | |
| RequestBody | The body that was passed in the Async API request. | Object | |
| Message | If successful, response data for the original API request is returned; otherwise null is returned. | Object | |
API URL
URL
GET
https://{async-host}/lead/status?RequestID=RequestID
URL Parameters
| Parameter | Description |
|---|---|
| RequestID | Id of the request returned by the Capture Leads (Async) API. |
Response
200 OK
Content-Type: application/json
{
"RequestId":"dd4114ac-2926-4889-bf36-2c44e7363d56",
"TaskStatus":{
"TaskType":"Lead Capture",
"Status":"Success",
"StatusReason":"Request was successfully completed",
"TaskCurrentStep":null,
"TaskLastStep":"In-Process-Queue",
"RequestBody":"[\r\n {\r\n\t\t\t\"Attribute\": \"EmailAddress\",\r\n\t\t\t\"Value\": \"Jhon@leadsquared.com\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Attribute\": \"FirstName\",\r\n\t\t\t\"Value\": \"Jhon\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Attribute\": \"LastName\",\r\n\t\t\t\"Value\": \"Will\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Attribute\": \"mx_City\",\r\n\t\t\t\"Value\": \"Delhi\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Attribute\": \"SearchBy\",\r\n\t\t\t\"Value\": \"EmailAddress\"\r\n\t\t}\r\n]",
"Message":"{\"Status\":\"Success\",\"Message\":{\"Id\":\"7efe1690-e835-4bdd-ab1f-424cdec286e5\",\"RelatedId\":\"3a284bbd-7a7b-4edd-a73e-ca112fb03a49\",\"IsCreated\":true}}"
}
}
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. |
