Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API, because mistakes happen. 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 reaching out to support with an error, please read the documentation and check your code carefully.

Status codes

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

Name
2xx
Description
A 2 xx status code indicates a successful response.
Name
4xx
Description
A 4 xx status code indicates a client error.
Name
5xx
Description
A 5 xx status code indicates a server error — hopefully you won't be seeing these.

Error types

Whenever a request is unsuccessful, the Tapp 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.

Here is a list of the two error types supported by the Tapp API — use these to understand what you have done wrong.

Name
api_error
Description
This means that we made an error.
Name
invalid_request
Description
This means that you made an error.

Example error response

{
	"type": "api_error",
	"message": "Something went wrong."
}