Note

This page is include on the internal docs build only.

Quick Quotes API

Endpoint Index

Action	Endpoint
Create Quick Quote	POST /policy/{tenantLocator}/quickquotes
Validate Quick Quote	PATCH /policy/{tenantLocator}/quickquotes/{locator}/validate
Fetch Quick Quote	GET /policy/{tenantLocator}/quickquotes/{locator}
Fetch Multiple Quick Quotes	GET /policy/{tenantLocator}/quickquotes/list
Price a Quick Quote	PATCH /policy/{tenantLocator}/quickquotes/{locator}/price
Fetch Pricing for Quick Quote	GET /policy/{tenantLocator}/quickquotes/{locator}/price
Update Quick Quote	PATCH /policy/{tenantLocator}/quickquotes/{locator}
Add Elements To Quick Quote	PUT /policy/{tenantLocator}/quickquotes/{locator}/elements
Delete Elements From Quick Quote	DELETE /policy/{tenantLocator}/quickquotes/{locator}/elements
Create Quote From Quick Quote	POST /policy/{tenantLocator}/quickquotes/{locator}/quote/{accountLocator}
Copy Quick Quote	POST /policy/{tenantLocator}/quickquotes/{locator}/copy
Reset Quick Quote	PATCH /policy/{tenantLocator}/quickquotes/{locator}/reset
Discard Quick Quote	PATCH /policy/{tenantLocator}/quickquotes/{locator}/discard
Assign Quick Quote To Group	PATCH /policy/{tenantLocator}/quickquotes/{locator}/assignToGroup
Fetch Quick Quotes for a Group	GET /policy/{tenantLocator}/quickquotes/group/{locator}/list

Create Quick Quote

createQuickQuote

POST /policy/{tenantLocator}/quickquotes

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:QuickQuoteCreateRequest
Response:QuickQuoteResponse
Security Group:quick-quotes   Permission:write

QuickQuoteCreateRequest

required
productName string
startTime datetime
endTime datetime
currency string
durationBasis Enum years | months | weeks | days | hours
timezone string
expirationTime datetime
data map<string,object>
coverageTerms map<string,string>
elements ElementResponse[]

Validate Quick Quote

validateQuickQuote

PATCH /policy/{tenantLocator}/quickquotes/{locator}/validate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:QuickQuoteResponse
Security Group:quick-quotes   Permission:write

Fetch Quick Quote

fetchQuickQuote

GET /policy/{tenantLocator}/quickquotes/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:QuickQuoteResponse
Security Group:quick-quotes   Permission:read

QuickQuoteResponse

required
locator string
groupLocator string
productName string
quickQuoteState Enum draft | validated | priced | quoted | discarded
element ElementResponse

optional
accountLocator string?
startTime datetime?
endTime datetime?
currency string?
duration number?
durationBasis Enum? years | months | weeks | days | hours
timezone string?
expirationTime datetime?
validationResult ValidationResult?

Fetch Multiple Quick Quotes

fetchMultipleQuickQuotes

GET /policy/{tenantLocator}/quickquotes/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:QuickQuoteListResponse
Security Group:quick-quotes   Permissions:read,list

QuickQuoteListResponse

required
listCompleted boolean
items QuickQuoteResponse[]

Price a Quick Quote

priceAQuickQuote

PATCH /policy/{tenantLocator}/quickquotes/{locator}/price

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:QuickQuotePriceResponse
Security Group:quick-quotes   Permission:write

QuickQuotePriceResponse

required
quickQuoteLocator string
tenantLocator uuid
productName string
startTime datetime
endTime datetime
duration number
durationBasis Enum years | months | weeks | days | hours
quickQuoteState Enum draft | validated | priced | quoted | discarded
items ChargeResponse[]
state Enum draft | validated | priced | quoted | discarded (deprecated)

optional
accountLocator string?

Fetch Pricing for Quick Quote

fetchPricingForQuickQuote

GET /policy/{tenantLocator}/quickquotes/{locator}/price

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:QuickQuotePriceResponse
Security Group:quick-quotes   Permission:read

Note

The Price a Quick Quote endpoint differs from Fetch Pricing for Quick Quote in that the former will advance the quick quote to priced state, and the latter will not change the state.

Update Quick Quote

updateQuickQuote

PATCH /policy/{tenantLocator}/quickquotes/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:QuickQuoteUpdateRequest
Response:QuickQuoteResponse
Security Group:quick-quotes   Permission:write

QuickQuoteUpdateRequest

required
startTime datetime
endTime datetime
currency string
expirationTime datetime
elements ElementUpdateRequest[]
removeCoverageTerms map<string,object>
removeData map<string,object>
setCoverageTerms map<string,string>
setData map<string,object>

Add Elements To Quick Quote

addElementsToQuickQuote

PUT /policy/{tenantLocator}/quickquotes/{locator}/elements

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:ElementResponse[]
Response:QuickQuoteResponse
Security Group:quick-quotes   Permission:write

Delete Elements From Quick Quote

deleteElementsFromQuickQuote

DELETE /policy/{tenantLocator}/quickquotes/{locator}/elements

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:string[]
Response:QuickQuoteResponse
Security Group:quick-quotes   Permission:write

Create Quote From Quick Quote

createQuoteFromQuickQuote

POST /policy/{tenantLocator}/quickquotes/{locator}/quote/{accountLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
accountLocator	path	string	required
markAsQuoted	query	boolean?	optional

Response:QuoteResponse
Security Group:quick-quotes   Permission:write

Copy Quick Quote

copyQuickQuote

POST /policy/{tenantLocator}/quickquotes/{locator}/copy

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:QuoteGroupAssignmentRequest
Response:QuickQuoteResponse
Security Group:quick-quotes   Permission:write

Reset Quick Quote

resetQuickQuote

PATCH /policy/{tenantLocator}/quickquotes/{locator}/reset

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:QuickQuoteResponse
Security Group:quick-quotes   Permission:write

Discard Quick Quote

discardQuickQuote

PATCH /policy/{tenantLocator}/quickquotes/{locator}/discard

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:QuickQuoteResponse
Security Group:quick-quotes   Permission:write

Assign Quick Quote To Group

assignQuickQuoteToGroup

PATCH /policy/{tenantLocator}/quickquotes/{locator}/assignToGroup

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:QuoteGroupAssignmentRequest
Response:QuickQuoteResponse
Security Group:quick-quotes   Permission:write

Fetch Quick Quotes for a Group

fetchQuickQuotesForAGroup

GET /policy/{tenantLocator}/quickquotes/group/{locator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:QuickQuoteListResponse
Security Group:quick-quotes   Permissions:read,list

See Also

• Quick Quotes Feature Guide