API Reference

Errors

QuoteCloud 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 charge failed, etc.). Codes in the 5xx range indicate an error with QuoteCloud's servers (these are rare).

Some 4xx errors that could be handled programmatically (e.g., a document created using invalid data) include an error code that briefly explains the error reported.

Attributes
type string
The type of error returned. One of api_error, document_error, or invalid_request_error
code string
For some errors that could be handled programmatically, a short string indicating the error code reported.
message string
A human-readable message providing more details about the error.
param string
If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

🚧

HTTP STATUS CODE SUMMARY

  • 200 - OK
    • Everything worked as expected.
  • 400 - Bad Request
    • The request was unacceptable, often due to missing a required parameter.
  • 401 - Unauthorised
    • No valid API key provided.
  • 402 - Request Failed
    • The parameters were valid but the request failed.
  • 403 - Forbidden
    • The API key doesn't have permissions to perform the request.
  • 404 - Not Found
    • The requested resource doesn't exist.
  • 429 - Too Many Requests
    • Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
  • 500, 502, 503, 504 - Server Errors
    • Something went wrong on QuoteCloud's end. (These are rare.)

📘

ERROR TYPES

api_error

  • API errors cover any other type of problem (e.g., a temporary problem with Stripe's servers), and are extremely uncommon.

document_error

  • Document errors are the most common type of error you should expect to handle. They result when data entered via the API is not valid within a document.

invalid_request_error

  • Invalid request errors arise when your request has invalid parameters.