Status & Error Codes

impact.com APIs may raise errors for various 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.

HTTP Status Code Summary

Code	Status	Description
🟢 200	OK	Everything worked as expected.
201	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 scoped tokens if they are disabled, or if the scoped token is enabled, but the specific endpoint is not enabled for that token.
🔴 404	Not found	The requested resource doesn’t exist.
🔴 405	Method not allowed	Method used in the call is not supported.
🔴 429	Too many requests	Too many requests hit the API too quickly. Reduce your requests significantly.
🔴 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 mean implementing a retry mechanism with an exponential drop-off in frequency.

Error Response Example

JSON

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

XML