Errors

Our APIs may raise errors for many reasons, such as a failed pathing, invalid parameters, authentication errors, and network unavailability. When a request returns an error, the system will provide a message to indicate more details about the failure. If there are particular errors found, they will be listed in the Errors array. Note that the Errors array is optional and will only be present when detailed error information is available.

HTTP Status Code Summary

Code	Status	Description
🟢 200	OK	Everything worked as expected.
🔴 400	Bad Request	Often missing a required parameter.
🔴 401	Unauthorized	No valid API key provided.
🔴 402	Request Failed	Parameters were valid but request failed.
🔴 403	Forbidden	Returned by open endpoints if they are disabled.
🔴 403	Access Denied	Returned by scoped tokens if they are disabled. Also returned if scoped token is enabled, but the specific endpoint is not enabled for that token.
🔴 404	Not Found	The requested item doesn’t exist.
🔴 500, 502, 503, 504	Server errors	Something went wrong on impact.com’s end.

While system errors are rare, we recommend writing code that gracefully handles all possible API exceptions. In many cases, these means implementing a retry mechanism with an exponential drop-off in frequency.

Detailed Error Response

{
  "Status": "ERROR",
  "Message": "Validation Failed",
  "Errors": [
    {
      "Field": "AccountId",
      "Message": "Not a numeric value"
    }
  ]
}

<ImpactRadiusResponse>
    <Status>ERROR</Status>
    <Message>Validation Failed</Message>
    <Errors>
        <Error>
      <Field>AccountId</Field>
      <Message>Not a numeric value</Message>
    </Error>
    </Errors>
</ImpactRadiusResponse>