Create Lead and Activity Status API
Returns the status of the lead and activity create request.
- Pass the
x-api-keyin the header, see Async API. - Pass the
RequestIdparameter returned by the Create a Lead and Activity (Async), in the query string.
Note: To get metrics for the Create a Lead and Activity (Async) API, see Get Create Lead and Activity Metrics.
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, “Activity Create Custom”. | String | |
| Status | The status of the task. Returned values are “Success” or “Error”. | Boolean | |
| 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}/activity/createcustom/status?RequestID=RequestID
URL Parameters
| Parameter | Description |
|---|---|
| RequestID | Id of the request returned by the Create a Lead and Activity (Async) API. |
Response
200 OK
Content-Type: application/json
{
"RequestId":"436c393c-1d13-4621-bca3-93c8da8d46ae",
"TaskStatus":{
"TaskType":"Activity Create Custom",
"Status":"Success",
"StatusReason":"Request was successfully completed",
"TaskCurrentStep":null,
"TaskLastStep":"In-Process-Queue",
"RequestBody":"{\r\n \"LeadDetails\": [\r\n {\r\n\t\t\t\"Attribute\": \"EmailAddress\",\r\n\t\t\t\"Value\": \"Sathya.Jagan@example.com\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Attribute\": \"FirstName\",\r\n\t\t\t\"Value\": \"Sathya\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Attribute\": \"LastName\",\r\n\t\t\t\"Value\": \"Jagan\"\r\n\t\t},\r\n {\r\n \"Attribute\": \"SearchBy\",\r\n \"Value\": \"EmailAddress\"\r\n },\r\n {\r\n\t\t\t\"Attribute\": \"Phone\",\r\n\t\t\t\"Value\": \"+91-4655450576\"\r\n\t\t},\r\n {\r\n\t\t\t\"Attribute\": \"mx_City\",\r\n\t\t\t\"Value\": \"Jaipur\"\r\n\t\t}\r\n ],\r\n \"Activity\": {\r\n \"ActivityEvent\": 498,\r\n \"ActivityNote\": \"Purchased Insurance\",\r\n \"Fields\": [\r\n {\r\n \"SchemaName\": \"mx_Custom_1\",\r\n \"Value\": \"Car\"\r\n },\r\n {\r\n \"SchemaName\": \"mx_Custom_2\",\r\n \"Value\": \"100000\"\r\n },\r\n {\r\n \"SchemaName\": \"mx_Custom_3\",\r\n \"Value\": \"2020-10-11 12:13:44\"\r\n },\r\n {\r\n \"SchemaName\": \"mx_Custom_4\",\r\n \"Value\": \"two\"\r\n },\r\n {\r\n \"SchemaName\": \"mx_Custom_5\",\r\n \"Value\": \"\",\r\n\t\t\t\"Fields\":[\r\n\t\t\t{\r\n \"SchemaName\": \"mx_CustomObject_1\",\r\n \"Value\": \"Car\"\r\n },\r\n\t\t\t{\r\n \"SchemaName\": \"mx_CustomObject_2\",\r\n \"Value\": \"23\"\r\n }\r\n\t\t\t]\r\n }\r\n ]\r\n }\r\n}",
"Message":"{\"Status\":\"Success\",\"Message\":{\"Id\":\"15e95848-572d-4c30-99b9-3d146f57ca0a\",\"RelatedId\":\"ecade67f-9426-4f39-b6c4-4ac9055ad694\"}}"
}
}
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. |
