Sign in

v1

latestOpenAPI 3.0.32026-07-24614422630.2 KB
Playbook

Get Generate Quote Template

Returns a preformatted JSON template for API quote generation based on the Playbook structure. Use this template as the starting point for Generate Quote API requests.

Date-type attributes and playbook questions are returned in the format yyyy-mm-dd hh:mm:ss.

Template generation rules:

  • The template includes all required API fields.
  • The template includes default values if they exist. Otherwise, it uses the first available answer.
  • The template excludes calculated questions.
get/api/version/{versionId}/playbook/{playbookId}/generate-quote-template

Path parameters

versionIdstring required

Version name.

playbookIdstring required

Playbook name (not the Playbook display name).

Response

Success. Returns the Generate Quote template JSON.

external_opportunity_idstring

Required. CRM opportunity ID. Required in all requests.

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

Required. Action for the quote. Enum, lowercase.

line_item_details'basic' | 'all'

Optional. Level of line item detail. basic includes SKU, bundle_ref, name, net price, list price, total discount, and product_factors.

playbookstring

Optional. Unique name of the playbook (UTF-8). If missing, the system uses the first API-type playbook.

quote_namestring

Optional. Quote or proposal name. The system default applies if missing; an error occurs if no default exists.

dealroom_publish_namestring

Optional. DealRoom publish name. The system default applies if missing; an error occurs if no default exists.

total_sales_discountnumber double

Optional. Total discount for all line items. Overrides individual line item discounts if provided.

expiration_datestring

Optional. Quote expiration date as a Unix timestamp in milliseconds (GMT). Must not be in the past; the system default applies if missing.

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

Required. Type of document.

timezone_offsetnumber

Optional. Timezone offset from GMT.

sign_externally_commentstring

Conditionally required. Comment for external signing. Required if request_action = sign_externally.