v1

latestOpenAPI 3.0.32026-07-24614422630.2 KB

Headless Quoting

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.

post/api/v1/quote/generate

Request body

external_opportunity_idstring required

CRM opportunity ID.

request_action'draft' | 'submit' | 'publish' | 'sign_externally' required

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

line_item_details'basic' | 'all'

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

playbookstring

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

quote_namestring

Quote or proposal name.

dealroom_publish_namestring

DealRoom publish name.

total_sales_discountnumber

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

expiration_dateinteger

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

document_type'DealRoom' | 'PDF' | 'WORD' | 'EXCEL' required

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

timezone_offsetnumber

Timezone offset from GMT in hours.

sign_externally_commentstring

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

Example request

{
  "quote_data": []
}

Response

Accepted. The quote generation process has been initiated.

statusstring

dealhub_proposal_idstring

dealhub_quote_idstring

dealroom_urlstring uri

approval_flowsboolean