GuidesAPI Reference
DocumentationLog In

Errors

Error response

All error messages include a type identifier and a human readable message.

validation_error with status code 400 is returned when the validation of the resource fails on POST or PUT requests. Response contains errors field with a list of errors.

Error response 400

{
    "error": {
        "type"  : "invalid_request",
        "message": "Required parameter missing: name"
    }
}

Warnings

Responses can include a warnings parameter to notify the developer of best practices, implementation suggestions or deprecation warnings. While you don’t need show warnings to the user, they are usually something you need to act on.

Example warning

{
    "warnings": [
      "Missing X-CC-Version header; serving latest API version (2018-03-22)"
    ]
}