Returns the status of the opportunity capture request.
- Pass the
x-api-keyin the header, see Async API.
- Pass the
RequestIdparameter returned by the Capture Opportunities (Async) API, in the query string.
The response JSON contains the following parameters –
|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||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|
|RequestID||Id of the request returned by the Capture Opportunities (Async) API.|
HTTP Response Codes
This is the status code for successful API call.
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.