At Outwrite, we use conventional HTTP code responses to help you understand what's going on with your requests. An HTTP code status range of 2xx
would indicate a successful request. A range of 4xx
or 5xx
indicates failure.
We always try to explain why an error occurred, and help you to fix your issue. Make sure to look at our documentation and follow the best practices.
HTTP Code description
HTTP Status | Description |
---|---|
2xx | Success. Always indicate a success. |
400 | Bad request. Most of the time a parameter is missing or not of the correct type. |
401 | Unauthorized. Make sure your API key is entered correctly and using the correct header format. Head to the Authentication page to fix your issue. |
403 | Forbidden. The API key doesn't have permissions to access this resource. |
404 | Not found. This resource has not been found. |
500 | Something went wrong. An error occurred on the Outwrite server. Try again or contact us if the issue is still happening. |
Our error object
{
"message": string
"status": number
"docUrl": string
"paramsError":[string]
}
Object property | Description |
---|---|
message | A human readable message. |
status | An HTTP code response. |
docUrl | A URL to get more information about the current error. |
paramsError | An array of messages that help you find out what's wrong. |