Successful responses have the following form, with a success field indicating that the request succeeded, and any response data under a results field:

{
  "success" true,
  "results": {...data...}
}

What would be 4XX errors will return 200 with success being false. Unsuccessful responses include an errorInfo object indicating what went wrong. For example:

{
  "success": false,
  "errorInfo": {
    "code": "application_not_found",
    "message": "Application not found - are you lacking permissions to edit candidates?",
    "requestId": "01JSJ8FEK5ZN4XQBZP7DBKK7ZC"
  },
}

In some cases, a request will go through but there may be minor problems with it. This will be indicated in an array of warning messages, like so for an imaginary request where we were able to create an application but failed to set some requested metadata on it:

{
  "success": true,
  "results": {...data...},
  "warnings": ["unable_to_add_application_metadata"]
}