Headless API Overview

The Headless Quotes API is a suite of services designed to programmatically create, simulate, and manage quotes from your backend system, without any direct user interaction within the DealHub user interface. This functionality allows you to automate your entire quoting process for specific scenarios.

The primary use cases for the Headless Quotes API are:

Automated Renewals: When a customer's contract is nearing its end, your system can automatically generate a new renewal quote and send it to them without a sales representative needing to to take action.
Self-Service Portals: Your customers can log into your own website or portal, select products, and receive a quote instantly, which is generated by DealHub on the backend.

Headless APIs

The Headless Quotes functionality is comprised of three core APIs endpoints that work together to provide a complete solution.

API	Description
Generate Quote API	The Generate Quote API is used to create an official quote object within DealHub. Unlike the simulate API, this process is always tied to an existing opportunity in your CRM. When you call this API, DealHub uses the current active version to generate the quote, creating a permanent record that you can then take action on.
Simulate Quote API	The Simulate Quote API acts as a real-time calculator. You send a request with product and configuration data, and DealHub returns a JSON response with the calculated pricing, line items, and proposal attributes. This API does not create a quote object in the DealHub system, nor does it generate any documents or DealRooms. It is ideal for powering pricing calculators on a self-service website where a user wants to see the price before committing to a formal quote.
Actions API	The Actions API allows you to perform programmatic lifecycle actions on an existing quote in DealHub. You can use this API to submit a quote for approval, publish it to a DealRoom, or mark it as signed externally. Typically, these actions are performed after a quote has been created using the Generate Quote API, the Actions API works with both headless and manual quotes, providing flexibility regardless of how the quote was created.

Billing

Generate Quote API: Calls to this endpoint count toward your API usage and will be billed.
Simulate Quote API: Calls to this endpoint are free of charge and do not affect your API usage.
Actions API: Calls to this endpoint are free of charge.

📘
The Actions API works with any quote, whether it was generated via the Headless APIs or created manually in the DealHub UI.

Requirements

All headless operations require a dedicated API Playbook:

An administrator must create this playbook using the Create API Playbook button in the version settings. This type of playbook has a simplified configuration, as it is not intended for direct user interaction.
All products, pricing rules, and output documents that will be used in headless quotes must be specifically associated with this API Playbook.

Next Steps

Creating An API Playbook: Before you use any of the Headless API's, you need to configure an API Playbook in your DealHub Web UI
How to Generate a Quote via API: Learn how to create a quote in DealHub by sending a JSON payload with all the required configuration data.
How to Simulate a Quote via API: Learn how to use the simulation endpoint to get real-time pricing calculations.
How to use the Actions API: Learn how to perform lifecycle actions on an existing quote, like submitting it for approval, publishing it to a DealRoom, or marking it as signed.
How to Generate and Manage a Headless Quote (Coming Soon): A guide on using the Generate Quote and Actions APIs to create and manage the full lifecycle of an automated quote.