Xola uses conventional HTTP response 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 failed given the information provided (e.g., a required parameter was omitted, a conflict occurred etc.), and codes in the 5xx range indicate an error with Xola's servers (these are rare).

200Everything worked as expected.
201New resource was created on Xola. Typically returned for a POST request.
202Request has been accepted for processing. Typically returned for long running processes such as schedule changes and report generation.
205Request was successfully processed but the server is not returning any content because multiple changes may have occurred. The client is expected to re-fetch the resource.
400The request was unacceptable, often due to missing a required parameter.
401No valid credentials provided. Ensure you have an X-API-KEY header provided with a valid API key
402The parameters were valid but the payment collection failed. Typically returned when charging a credit card fails.
403You do not have the access to this resource
404The requested resource doesn't exist.
409The request could not be processed due to a resource mismatch. Typically returned when capacity or configuration has changed and the server can no longer honor the request.
5xxSomething went wrong on Xola's end. (These are rare.)

Updated 4 months ago


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.