Update an Opportunity Status API
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Returns the status of the opportunity update request.
- Pass the
x-api-keyin the header, see Async API. - Pass the
RequestIDparameter returned by the Update an Opportunity (Async) API, in the query string.
Note: To get metrics for the Update an Opportunity (Async) API, see Get Update Opportunity 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}/opportunity/update/status?RequestID=RequestID
URL Parameters
| Parameter | Description |
|---|---|
| RequestID | Id of the request returned by the Update an Opportunity (Async) API. |
Response
200 OK
Content-Type: application/json
{
"RequestID":"5ebec781-c325-41f0-914e-9692301a2515",
"TaskStatus":{
"TaskType":"Opportunity Update",
"Status":"Success",
"StatusReason":"Request was successfully completed",
"TaskCurrentStep":null,
"TaskLastStep":"In-Process-Queue",
"RequestBody":"{\r\n\r\n \"ProspectOpportunityId\": \"6a22455b-213e-4450-a960-3deef72b5eec\",\r\n \r\n \"OpportunityNote\": \"Insurance details\",\r\n \"Fields\": [\r\n \r\n\t\t{\r\n \"SchemaName\": \"mx_Custom_5\",\r\n \"Value\": \"Car Insurance\"\r\n },\r\n {\r\n \"SchemaName\": \"mx_Custom_6\",\r\n \"Value\": \"100000\"\r\n }\r\n ]\r\n}",
"Message":"{\"Status\":\"Success\",\"Message\":{\"Id\":\"6a22455b-213e-4450-a960-3deef72b5eec\"}}"
}
}
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. |
