Errors

Our API uses normal HTTP response codes to provide feedback with errors, however in most cases the body of the response will include an error code that can be used, and a message with additional context.

Example 400 error response

{
    "result": {
        "type": "error",
        "reason": "invalid_json_syntax",
        "messages": [
            "Invalid JSON syntax in request body."
        ]
    }
}

Common error codes

This is a list of error codes that are shared across all endpoints, however each individual endpoint may have its own contextual error response as well.

missing_required_field

missing_required_params

invalid_params

invalid_json_syntax