Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).

Status codes

Here is a list of the different categories of status codes returned by the API. Use these to understand if a request was successful.

Name
2xx
Description
A 2xx status code indicates a successful response.
Name
4xx
Description
A 4xx status code indicates a client error.
Name
5xx
Description
A 5xx status code indicates a server error.

Error types

Whenever a request is unsuccessful, the API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Error response

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-230b04b43aa45eecc8ad07dfe1cacecc-54ffac067ffca022-00",
"errors": 
  {
    "Product": [
        "The Product field is required."
    ],
    "Purpose": [
        "The Purpose field is required."
    ],
    "ExternalApplicationId": [
        "The ExternalApplicationId field is required."
    ]
  }
}