Note

This page is include on the internal docs build only.

Quick Quotes API

Endpoint Index

ActionEndpoint
Create Quick QuotePOST /policy/{tenantLocator}/quickquotes
Validate Quick QuotePATCH /policy/{tenantLocator}/quickquotes/{locator}/validate
Fetch Quick QuoteGET /policy/{tenantLocator}/quickquotes/{locator}
Fetch Multiple Quick QuotesGET /policy/{tenantLocator}/quickquotes/list
Price a Quick QuotePATCH /policy/{tenantLocator}/quickquotes/{locator}/price
Fetch Pricing for Quick QuoteGET /policy/{tenantLocator}/quickquotes/{locator}/price
Update Quick QuotePATCH /policy/{tenantLocator}/quickquotes/{locator}
Add Elements To Quick QuotePUT /policy/{tenantLocator}/quickquotes/{locator}/elements
Delete Elements From Quick QuoteDELETE /policy/{tenantLocator}/quickquotes/{locator}/elements
Create Quote From Quick QuotePOST /policy/{tenantLocator}/quickquotes/{locator}/quote/{accountLocator}
Copy Quick QuotePOST /policy/{tenantLocator}/quickquotes/{locator}/copy
Reset Quick QuotePATCH /policy/{tenantLocator}/quickquotes/{locator}/reset
Discard Quick QuotePATCH /policy/{tenantLocator}/quickquotes/{locator}/discard
Assign Quick Quote To GroupPATCH /policy/{tenantLocator}/quickquotes/{locator}/assignToGroup
Fetch Quick Quotes for a GroupGET /policy/{tenantLocator}/quickquotes/group/{locator}/list
Create Quick Quote
createQuickQuote
POST /policy/{tenantLocator}/quickquotes
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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:quick-quotes   Permission:write
Fetch Quick Quote
fetchQuickQuote
GET /policy/{tenantLocator}/quickquotes/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:quick-quotes   Permission:read
QuickQuoteResponse
required
locator locator
groupLocator locator
productName string
quickQuoteState Enum draft | validated | priced | quoted | discarded

optional
accountLocator locator?
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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:quick-quotes   Permissions:read,list
QuickQuoteListResponse
required
listCompleted boolean
Price a Quick Quote
priceAQuickQuote
PATCH /policy/{tenantLocator}/quickquotes/{locator}/price
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:quick-quotes   Permission:write
QuickQuotePriceResponse
required
quickQuoteLocator locator
tenantLocator uuid
productName string
startTime datetime
endTime datetime
duration number
durationBasis Enum years | months | weeks | days | hours
quickQuoteState Enum draft | validated | priced | quoted | discarded
state Enum draft | validated | priced | quoted | discarded (deprecated)

optional
accountLocator locator?
Fetch Pricing for Quick Quote
fetchPricingForQuickQuote
GET /policy/{tenantLocator}/quickquotes/{locator}/price
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:quick-quotes   Permission:write
QuickQuoteUpdateRequest
required
startTime datetime
endTime datetime
currency string
expirationTime datetime
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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Request:ElementResponse[]
    Security Group:quick-quotes   Permission:write
Delete Elements From Quick Quote
deleteElementsFromQuickQuote
DELETE /policy/{tenantLocator}/quickquotes/{locator}/elements
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Request:locator[]
    Security Group:quick-quotes   Permission:write
Create Quote From Quick Quote
createQuoteFromQuickQuote
POST /policy/{tenantLocator}/quickquotes/{locator}/quote/{accountLocator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    accountLocatorpathlocatorrequired
    markAsQuotedqueryboolean?optional
    Response:QuoteResponse
    Security Group:quick-quotes   Permission:write
Copy Quick Quote
copyQuickQuote
POST /policy/{tenantLocator}/quickquotes/{locator}/copy
Reset Quick Quote
resetQuickQuote
PATCH /policy/{tenantLocator}/quickquotes/{locator}/reset
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:quick-quotes   Permission:write
Discard Quick Quote
discardQuickQuote
PATCH /policy/{tenantLocator}/quickquotes/{locator}/discard
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:quick-quotes   Permission:write
Assign Quick Quote To Group
assignQuickQuoteToGroup
PATCH /policy/{tenantLocator}/quickquotes/{locator}/assignToGroup
Fetch Quick Quotes for a Group
fetchQuickQuotesForAGroup
GET /policy/{tenantLocator}/quickquotes/group/{locator}/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:quick-quotes   Permissions:read,list

See Also