Create Quote

post

https://api.dealhub.io/api/v1.1/quote/create

Creates a new quote in DealHub and returns a URL to redirect the user to. This is a client-side call that must be authenticated with the one-time access token obtained from the /user/authenticate endpoint. This version supports subscription renewals via the repeatable_groups parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

A schema representing the data that can be sent to create or update an opportunity and its related quote.

external_opportunity_name

string

required

length ≤ 200

CRM opportunity name.

opportunity_owner

object

Details of the opportunity owner, which are required when a quote is created by a user other than the actual opportunity owner.

external_quote_id

string

length ≤ 50

CRM quote ID.

external_customer_id

string

required

length ≤ 50

CRM customer ID (buyer account).

customer_name

string

required

length ≤ 256

CRM customer name.

customer_shipping_address

object

Customer shipping address information.

customer_billing_address

object

Customer billing address information.

customer_contacts

array of objects

List of customer contacts.

customer_contacts

geo_code

string

required

length ≤ 100

Geographic code.

currency

string

required

length ≤ 3

The currency ISO code. This is immutable once an opportunity/quote is created.

custom_fields

array of objects

A list of custom fields, where each object contains a key/value pair. This parameter supports the following data types:

Numeric: A single numeric value. An empty value will be treated as 0.
Text: The value is captured and presented to the user exactly as received. The value field must be an array with a single string.
Text list: Can contain one or more values. This can be used in two modes:
- Single-select: Only one value can be chosen from the list.
- Multi-select: Multiple values from the list can be selected.
UTC: A date and time value. The format must be yyyy-mm-dd. An empty value will be treated as NULL.

custom_fields

repeatable_groups

array of objects

Used for subscription renewals. The system will attempt to render this data into the playbook; items that cannot be rendered will be ignored without error.

repeatable_groups

dealhub_user_id

string

required

length ≤ 16

ID of the user in the DealHub system (as returned from the Authentication request).

external_opportunity_id

string

required

length ≤ 50

CRM opportunity ID.

version_id

string

length ≤ 16

For admin use only. DealHub version ID. If not specified, the system will use the active version.

Responses

200Request accepted.

400Bad Request.

403Unauthenticated. The one-time access token is missing, invalid, or expired.