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 |
POST /policy/{tenantLocator}/quickquotesRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
Request:QuickQuoteCreateRequest
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
QuickQuoteCreateRequest
¶requiredproductName stringstartTime datetimeendTime datetimecurrency stringdurationBasis Enum years | months | weeks | days | hourstimezone stringexpirationTime datetimedata map<string,object>coverageTerms map<string,string>elements ElementResponse[]
PATCH /policy/{tenantLocator}/quickquotes/{locator}/validateRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
GET /policy/{tenantLocator}/quickquotes/{locator}Request Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:read
QuickQuoteResponse
¶requiredlocator locatorgroupLocator locatorproductName stringquickQuoteState Enum draft | validated | priced | quoted | discardedelement ElementResponseoptionalaccountLocator locator?startTime datetime?endTime datetime?currency string?duration number?durationBasis Enum? years | months | weeks | days | hourstimezone string?expirationTime datetime?validationResult ValidationResult?
GET /policy/{tenantLocator}/quickquotes/listRequest 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
¶requiredlistCompleted booleanitems QuickQuoteResponse[]
PATCH /policy/{tenantLocator}/quickquotes/{locator}/priceRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:QuickQuotePriceResponse
Security Group:quick-quotes  Permission:write
QuickQuotePriceResponse
¶requiredquickQuoteLocator locatortenantLocator uuidproductName stringstartTime datetimeendTime datetimeduration numberdurationBasis Enum years | months | weeks | days | hoursquickQuoteState Enum draft | validated | priced | quoted | discardeditems ChargeResponse[]state Enum draft | validated | priced | quoted | discarded (deprecated)optionalaccountLocator locator?
GET /policy/{tenantLocator}/quickquotes/{locator}/priceRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | 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.
PATCH /policy/{tenantLocator}/quickquotes/{locator}Request Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Request:QuickQuoteUpdateRequest
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
QuickQuoteUpdateRequest
¶requiredstartTime datetimeendTime datetimecurrency stringexpirationTime datetimeelements ElementUpdateRequest[]removeCoverageTerms map<string,object>removeData map<string,object>setCoverageTerms map<string,string>setData map<string,object>
PUT /policy/{tenantLocator}/quickquotes/{locator}/elementsRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Request:ElementResponse[]
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
DELETE /policy/{tenantLocator}/quickquotes/{locator}/elementsRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Request:locator[]
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
POST /policy/{tenantLocator}/quickquotes/{locator}/quote/{accountLocator}Request Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| accountLocator | path | locator | required |
| markAsQuoted | query | boolean? | optional |
Response:QuoteResponse
Security Group:quick-quotes  Permission:write
POST /policy/{tenantLocator}/quickquotes/{locator}/copyRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Request:QuoteGroupAssignmentRequest
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
PATCH /policy/{tenantLocator}/quickquotes/{locator}/resetRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
PATCH /policy/{tenantLocator}/quickquotes/{locator}/discardRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
PATCH /policy/{tenantLocator}/quickquotes/{locator}/assignToGroupRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Request:QuoteGroupAssignmentRequest
Response:QuickQuoteResponse
Security Group:quick-quotes  Permission:write
GET /policy/{tenantLocator}/quickquotes/group/{locator}/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| offset | query | int? | optional |
| count | query | int? | optional |
| extended | query | boolean? | optional |
Response:QuickQuoteListResponse
Security Group:quick-quotes  Permissions:read,list