The API uses standard HTTP status codes to display the results of a request. 2xx codes indicate success, while all other codes indicate some form of error.

An error response consists of several objects you can use to help with troubleshooting:

  • errors. This array lists the things that went wrong with your request. It includes as many of the problems in the response as possible.
  • field. This pertains to an error based on a specific field in any JSON you've submitted. The API omits this from an error response if there isn't a relevant field.
  • reason. This is a human-readable explanation of the error.

Errors are logged and we work quickly to resolve issues. If you continue to see repeat errors, you can open a support ticket. In the ticket, provide us with reproducible steps and as much data as you can.