Post an Activity on a Lead Status API
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Returns the status of the activity post request.
- Pass the
x-api-keyin the header, see Async API. - Pass the
RequestIdparameter returned by the Post Activity on Lead (Async) API, in the query string.
Note: To get metrics for the Post an Activity on a Lead (Async) API, see Get Post Activity on Lead Metrics API.
The response JSON contains the following parameters –
| Parameter |
Description | Type | |
| RequestId | ID of the request. | String | |
| TaskStatus | Top-level object. Contains details of the task status. | Object | |
| TaskType | The task type related to the request. For example, “Opportunity Update”. | 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}/activity/create/status?RequestID=RequestID
URL Parameters
| Parameter | Description |
|---|---|
| RequestID | Id of the request returned by the Post Activity on Lead (Async) API. |
Response
200 OK
Content-Type: application/json
{
"RequestId":"72003d66-aa5d-4533-9e13-73da598dedf4",
"TaskStatus":{
"TaskType":"Activity Create",
"Status":"Success",
"StatusReason":"Request was successfully completed",
"TaskCurrentStep":null,
"TaskLastStep":"In-Process-Queue",
"RequestBody":"\r\n {\r\n \"RelatedProspectId\": \"b8e49bf4-3b56-49e0-a339-4cc5832d0e34\",\r\n \"ActivityEvent\": 380,\r\n \"ActivityNote\": \"Your Activity Note\",\r\n \"ActivityDateTime\": \"2020-10-11 12:13:44\",\r\n \"Fields\": [\r\n {\r\n \"SchemaName\": \"mx_Custom_1\",\r\n \"Value\": \"string\"\r\n },\r\n {\r\n \"SchemaName\": \"mx_Custom_2\",\r\n \"Value\": \"123\"\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\": \"Cus string\"\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}",
"Message":"{\"Status\":\"Success\",\"Message\":{\"Id\":\"a184879a-795c-46cb-909c-8a54ec66dc7b\",\"RelatedId\":\"b8e49bf4-3b56-49e0-a339-4cc5832d0e34\"}}"
}
}
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. |
