Added

New Quote Reason Field and Agency Quotes Filter

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 - new quoteReason field
  • POST /v3/quoting/quote - new quoteReason field
  • PATCH /v3/quoting/quote/:id - new quoteReason field
  • POST /v3/quoting/quote/:id/finalize - new quoteReason field
  • GET /v3/agency/quotes - new quoteReason field and new quote_reasons filter parameter

New field: quoteReason on all quote responses

Every quote object returned by the endpoints above now includes a quoteReason field.

ValueMeaning
new_businessStandard new-customer quote
endorsementMid-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&quote_reasons[]=endorsement
GET /v3/agency/quotes?bound=false&quote_reasons[]=endorsement

Omitting quote_reasons continues to return all quote types.

This is an additive, non-breaking change. Existing integrations require no changes.