Added
New Quote Reason Field and Agency Quotes Filter
28 days ago by Root Insurance
quoteReason is now included in the response of all CP API endpoints that return a quote, and the GET /v3/agency/quotes endpoint now accepts an optional quote_reasons query parameter to filter results by quote reason.
Affected endpoints
GET /v3/quoting/quote/:id- newquoteReasonfieldPOST /v3/quoting/quote- newquoteReasonfieldPATCH /v3/quoting/quote/:id- newquoteReasonfieldPOST /v3/quoting/quote/:id/finalize- newquoteReasonfieldGET /v3/agency/quotes- newquoteReasonfield and newquote_reasonsfilter parameter
New field: quoteReason on all quote responses
Every quote object returned by the endpoints above now includes a quoteReason field.
| Value | Meaning |
|---|---|
new_business | Standard new-customer quote |
endorsement | Mid-term modification to an active policy |
Example response:
{
"id": "...",
"status": "quoted",
"kind": "bindable_quote",
"quoteReason": "new_business",
...
}New filter: quote_reasons on GET /v3/agency/quotes
Pass one or more quote_reasons[] values to restrict results to quotes of that type. Composes with the existing bound filter.
GET /v3/agency/quotes?quote_reasons[]=endorsement
GET /v3/agency/quotes?quote_reasons[]=new_business
GET /v3/agency/quotes?quote_reasons[]=new_business"e_reasons[]=endorsement
GET /v3/agency/quotes?bound=false"e_reasons[]=endorsement
Omitting quote_reasons continues to return all quote types.
This is an additive, non-breaking change. Existing integrations require no changes.