PageUp APIs return standard HTTP success or error status codes. Error responses may also include extra information about what went wrong, encoded as JSON (see Error response). The various HTTP status codes that might be returned are listed below.
| Code | Title | Description |
|---|---|---|
| 200 | OK | The request was successful. |
| 201 | Created | The resource was successfully created. |
| 202 | Accepted | The resource will be created asynchronously. |
| 400 | Bad request | Bad request |
| 401 | Unauthorized | Your API key is invalid or expired |
| 403 | Forbidden | You do not have permission to access the resource. |
| 404 | Not found | The resource does not exist. |
| 429 | Rate limit exceeded | The daily rate limit has been exceeded. |
| 50X | Internal Server Error | An error occurred with the API. |
All error responses are returned in the form of an array of JSON objects containing a message and optional field property. Example error response.
[
{
"message": "You are not allowed to perform this action at this time"
},
{
"field": "name",
"message": "Name is required"
}
]