Errors

How errors are formatted in the Whippy API.

The Whippy Public Open API uses standard HTTP status codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing), and codes in the 5xx range indicate an error with Whippy's servers.

When an error occurs, the API will return a JSON object in the response body, which includes the following fields:

  • The description, a human-readable message providing more details about the error.
  • The HTTP status code of the response.

Here's an example of what an error response might look like:

{
  "errors": [
    {
      "description": "Not authenticated"
    }
  ],
  "status": 401
}