Generate a Quote

Creates an official quote record in DealHub, links it to a CRM opportunity, and initiates any required approval workflows based on your active CPQ version.

This is an asynchronous endpoint. When you send a request, the API provides an immediate response to confirm that the quote generation process has started. The full processing, including data synchronization with your CRM, happens in the background.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 50

CRM opportunity ID.

string
enum
required

Specifies the action (draft, submit, publish, or sign).

Allowed:
string
enum
Defaults to basic

Determines the level of detail included in the response for line items.

Allowed:
string
length ≤ 50

The unique name of the playbook (not the display name). If not provided, the system uses the first API-type playbook.

string
length ≤ 250

Quote or proposal name.

string
length ≤ 250

DealRoom publish name.

number

Total discount for all line items. Overrides default line-item discounts if provided.

int64

Quote expiration date as a Unix timestamp (milliseconds, GMT).

string
enum
required

Specifies document type (e.g., DealRoom, PDF, WORD).

Allowed:
partner_program
array of objects

List of selected partner programs.

partner_program
number

Timezone offset from GMT in hours.

string
length ≤ 1000

Includes the necessary comments for external signing. It is required if request_action is sign_externally.

quote_data
array of objects
required
Defaults to []

List of question group data, including questions and answers.

quote_data*
line_items
array of objects

A list of line items and their associated data. The system only validates that the SKU for each item exists. All other provided details are accepted as-is, and any existing data for these line items will be overwritten.

line_items
opportunity_data
object

Opportunity context required for CRM API tenants. Must be provided when the DealHub tenant uses the CRM API integration type.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json