Edit

Errors

In addition to the HTTP response status code, known API errors are wrapped in a payload object. This aims to provide some more context into why the error happened. For example:

{
  "error": {
    "code": "ErrorIdentifier",
    "message": "Human readable information"
  }
}

Known errors

Status code: 400

{
  "error": {
    "code": "BadRequest",
    "message": "Your request seems to be invalid or malformed"
  }
}

Status code: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "You are not authorized to access this resource"
  }
}

Status code: 402

{
  "error": {
    "code": "PaymentRequired",
    "message": "You seem to have reached your plan limit"
  }
}

Status code: 404

{
  "error": {
    "code": "NotFound",
    "message": "The requested resource could not be found"
  }
}

Status code: 409

{
  "error": {
    "code": "AlreadyExists",
    "message": "This resource already exists"
  }
}

Status code: 413

{
  "error": {
    "code": "PayloadTooLarge",
    "message": "Payload too large"
  }
}

Status code: 422

{
  "error": {
    "code": "UnprocessableEntity",
    "message": "We understood the request, but are unable to process it"
  }
}

Status code: 429

{
  "error": {
    "code": "TooManyRequests",
    "message": "You are sending too many requests, please try again later"
  }
}

Status code: 500

{
  "error": {
    "code": "Internal",
    "message": "Something wen't wrong, that's all we know"
  }
}