Web service requests fired at the Integration Gateway Unified API may fail for a variety of reasons, including invalid request data, network connectivity problems, core outages, and authorization restrictions.

The API will return a non-2XX status HTTP response if one or more of the requested operations fail. The response will attempt to provide useful error information in response message objects when possible.

Different types of errors will result in different response payload content and formats. Assuming a request reaches the server and successfully authenticates, client applications can expect the operation's JSON response object (nested within the entire HTTP response body JSON list) to match the following format:

{
    "success": false,
    "payload": null,
    "messages": [
        {
            "type": "<ERROR_TYPE>",
            "text": "<ERROR_MESSAGE>"
        }
    ]
}

See service-specific example responses that further demonstrate the API's error behavior in their respective API reference pages.