Status and Error Codes

Any request that returns an error follows a standard format. Conga Revenue Cloud returns an array of errors that contain status, title, and details objects. You’ll most likely receive an error if validation fails, something you requested doesn’t exist, or something went wrong on our end. We return errors inline with the JSON API specification.

Conga Revenue Cloud uses standard HTTP status codes to determine the response status. The following table lists the generic rules:

CodeResponse
2xxThe request completed successfully.
4xxThe request failed due to a problem with the request.
5xxThe request failed due to a problem with Conga Revenue Cloud.

For more information, see the documentation for individual calls. Additionally, the 429 error code indicates that the request exceeds the allowed rate limits in Conga Revenue Cloud.

Example Errors

This section contains some example error responses from the API.

Bad Request

A 400: Bad Request response is returned for all other errors, such as validation failures or invalid JSON in the request body.

{
  "errors": [
    {
      "Source": "client",
      "Title": "required",
      "Detail": "enabled is required",
      "Link" : "https://support.conga.com"
    }
  ]
}

Unauthorized

A 401: Unauthorized response is returned when you provide an invalid authentication token.

{
  "errors": [
    {
      "Source": "client",
      "Title": "Invalid Access Token",
      "Detail": "Unable to validate access token",
      "Link" : "https://support.conga.com"
    }
  ]
}

No Content

A 204: No Content response is returned when the request is successful, but there are no results

{
  "errors": [
    {
      "Source": "client",
      "Title": "No Content",
      "Detail": "The request did not return any results.",
      "Link" : "https://support.conga.com"
    }
  ]
}

Rate Limited

A 429: Too Many Requests response is returned when you make too many requests.

{
  "errors": [
    {
      "Source": "client",
      "Title": "Rate Limit",
      "Detail": "You've exceeded the allowed number of requests.",
      "Link" : "https://support.conga.com"
    }
  ]
}

Internal Server Error

A 500: Internal Server Error response is returned for any back-end errors in Conga Revenue Cloud. Any internal errors are tracked and monitored by the Conga team to resolve any issues as quickly as possible.

{
  "errors": [
    {
      "Source": "server",
      "Title": "Internal Server Error",
      "Detail": "There was an internal server error",
      "Link" : "https://support.conga.com"
    }
  ]
}