Referral Factory's API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your API key is incorrect. |
| 403 | Forbidden -- The resource requested is marked for administrators only. |
| 404 | Not Found -- The specified resource could not be found. |
| 405 | Method Not Allowed -- You tried to access a resource with an invalid method. |
| 406 | Not Acceptable -- You requested a format that isn't in JSON format. |
| 410 | Gone -- The resource requested has been removed from the data server. |
| 429 | Too Many Requests -- You're requesting too many resources at one time. |
| 500 | Internal Server Error -- We had a problem with our server. Please try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |
Errors should be returned as JSON structured like this:
{
"code": 422,
"message": "Validation errors in your request",
"errors": {
"email": [
{
"field": "email",
"message": "The email field is required."
}
]
}
}