Error Reference (v1)
This page provides a reference for the HTTP error codes and associated messages you may encounter while using the DealHub APIs. The errors are organized into common errors that apply across multiple APIs and errors that are specific to a single API.
V2 Endpoints
This page provides error references for V1 endpoints, including
Simulate Quote,Generate Quote, andActionsAPIs. For errors related to V2 endpoints, please see the V2 Error Reference.
Placeholders in Error Messages
Error messages often contain placeholders (e.g.,
[Group ID - Question ID],<SKU>) that are replaced dynamically with specific values in the actual response.
Asynchronous Errors
Failures for asynchronous operations, such as activating a new version, are sent via Failure WebHooks.
General Errors
These HTTP 400 errors can be returned by multiple V1 API calls and typically relate to issues with payload data, configuration, or entities that cannot be found.
| When it occurs | Error Message |
|---|---|
| The request payload is missing one or more required fields. | "Invalid payload data. [{Field: <field>, Message: must not be null, Value: null}]" |
| A parameter in the request payload exceeds its allowed character limits. | "Invalid payload data. [{Field: quoteName, Message: size must be between 0 and 250, Value: <value>}]" |
| An unrecognized parameter was included in the request payload. | "Unrecognized field: <field>." |
| The system attempted to retrieve a quote or opportunity that does not exist. | "Entity (ID = <entity ID>) not found." |
| An invalid value was provided for one of the parameters in the request. | "Invalid request: The value <invalid value> is not supported in DealHub. Supported values: <list of supported values>." |
An API request is made, but no ACTIVE version is configured in the system. | "Request failed: No active version is configured in the system." |
The version_id specified in a Simulate request does not exist. | "Simulation failed: The provided version ID does not exist in the system." |
The dealhub_proposal_id does not exist when trying to retrieve a dealhub_quote_id. | "Error: Unable to retrieve DealHub quote ID. The specified DealHub proposal ID does not exist." |
| The specified playbook does not exist, is disabled, or is not of type 'API'. | "Quote generation failed: The provided playbook does not exist in the system." or "Quote generation failed: The playbook must be of type 'API' to proceed." |
A required dealroom_publish_name or quote_name is missing or invalid. | "Quote generation failed: The DealRoom publish name does not exist or is invalid." |
| The expiration date is missing, invalid, or in the past. | "Quote generation failed: The expiration date does not exist or is invalid." or "Quote generation failed: The specified expiration time has already passed." |
| A required document or DealRoom template is not available for the quote. | "Quote generation failed: The document template is not available for this quote." |
| A required answer to a mandatory question is missing. | "Quote generation failed: Mandatory question is missing: <mandatory question name>." |
The provided SKU in the line_items parameter does not exist in the system. | “Quote generation failed: The SKU <SKU> does not exist in the system.” |
Quote Actions Errors
The following HTTP 400 errors are specific to the Quote Actions API (/submit, /publish, /sign_externally).
| When it occurs | Error Message |
|---|---|
The quote fails validation checks during a submit, publish, or sign_externally action. | "Submission failed: The quote did not pass submit validation requirements." |
| An action is attempted that requires approval, but the approval has not been granted. | "Publish quote failed: Approval is required before the quote can be published." |
| An attempt is made to perform an action on a quote that has already had that action performed. | "Submission failed: The quote has already been submitted." |
An attempt is made to publish a quote whose document type is not DealRoom. | "Publish quote failed: The quote's document type must be 'DealRoom' to proceed." |
A sign_externally action fails because the quote is in a draft status. | “Sign quote externally failed: The quote is in a draft status.” |
Quote Generation Errors: Invalid quote_data
quote_dataThe following HTTP 400 errors occur when the quote_data field contains invalid values during a generate or simulate request.
| Invalid Data | Error Message |
|---|---|
For a Text List question, the provided answer is not in the predefined list of options. | "Quote generation failed: The answer for [Group ID - Question ID] contains invalid values. Not found in the predefined list." |
For a Text Answer question, the answer exceeds the maximum character limit. | "Quote generation failed: The answer for [Group ID - Question ID] contains invalid values. Exceeds the maximum character limit." |
For a Manual Item question, the provided SKU does not exist in the system. | "Quote generation failed: The answer for [Group ID - Question ID] contains invalid values. SKU not found in the system." |
For a Numeric Answer/Range question, the value is outside the defined min/max limits. | "Quote generation failed: The answer for [Group ID - Question ID] contains invalid values. Below the allowed minimum limit." |
For a Date question, the date is not in the required yyyy-MM-dd format. | "Quote generation failed: The answer for [Group ID - Question ID] contains an invalid date format. Expected format: yyyy-MM-dd." |
Quote Generation Errors: Invalid line_item Attributes
line_item AttributesThe following HTTP 400 errors occur when proposal attributes within a line_item have invalid values.
| Invalid Data | Error Message |
|---|---|
| A proposal attribute exceeds the maximum allowed character limit. | "Quote generation failed: The proposal attribute for line_item[SKU] contains invalid values and exceeds the character limit.” |
A non-numeric value is provided for a Numeric, Currency, or Percentage attribute. | “Quote generation failed: The proposal attribute [proposal attribute] for line_item[SKU] contains invalid values. The value is not numeric." |
A Date attribute is provided in an invalid format. | "Quote generation failed: The proposal attribute [proposal attribute] for line_item[SKU] contains invalid values. Contains an invalid date format. Expected format: yyyy-MM-dd (GMT)” |
Updated about 1 month ago