v4

latestOpenAPI 3.1.02026-08-0421336267.5 KB
Draft Quote

Quote Update

Update fields on an existing draft quote.

put/v1/agency/draft_quote/{quote_id}

Path parameters

quote_idstring nullable required

Query parameters

offer_idstring nullable
policy_idstring nullable

Request body

policy_type'DP1' | 'DP2' | 'DP3' required

An enumeration.

insurance_structure'COI_MASTER_MGA' | 'STANDARD_MGA' | 'XMGA' | 'ARCHIVED'

An enumeration.

effective_datestring date

Effective date in YYYY-MM-DD format. Defaults to today.

effective_date_timezonestring nullable
previous_policy_idstring nullable
renewal_policy_idstring nullable
renewal_quote_idstring nullable
renewal_status'draft' | 'quoted' | 'bound' | 'invalidated'

An enumeration.

renewal_start_datestring date nullable
renewal_end_datestring date nullable
quote_idstring required
force_rerun_lookupsboolean nullable
valuation_update_behavior'skip' | 'default' | 'force'

Controls valuation update behavior.

SKIP: No valuation update (default for endorsements - preserves current behavior) DEFAULT: Update if dwelling fields changed FORCE: Always update (e.g., EditPlugin updated valuation externally)

force_valuation_dwelling_idsstring[] nullable

Example request

{
  "primary_insured": {
    "mailing_address": {
      "street_address": "4825 Mount Sinyala Crossover",
      "city": "Fort Wayne",
      "state": "IN",
      "zip_code": "46808"
    },
    "previous_address": {
      "street_address": "4825 Mount Sinyala Crossover",
      "city": "Fort Wayne",
      "state": "IN",
      "zip_code": "46808"
    }
  },
  "additional_named_insured": [
    {
      "address": {
        "street_address": "4825 Mount Sinyala Crossover",
        "city": "Fort Wayne",
        "state": "IN",
        "zip_code": "46808"
      }
    }
  ],
  "effective_date": "2022-01-15",
  "policy_details": {
    "unique_tracking_id": "id-12345"
  },
  "properties": [
    {
      "property_id": "acf85fa5-4200-4303-96ba-012e546ff628",
      "address": {
        "street_address": "4825 Mount Sinyala Crossover",
        "city": "Fort Wayne",
        "state": "IN",
        "zip_code": "46808",
        "county": "Maricopa",
        "county_fips": "04013",
        "lat": 41.079273,
        "lng": -85.139351
      },
      "property_coverages": [
        {
          "name": "water_damage_limitation",
          "config": [
            {
              "type": "limit",
              "label": "Water Damage Limitation",
              "value": "10%"
            },
            {
              "type": "sublimit",
              "label": "Water Damage Limitation - Fungi Rot Sublimit",
              "value": "5000"
            }
          ]
        }
      ],
      "property_manager": {
        "address": {
          "street_address": "4825 Mount Sinyala Crossover",
          "city": "Fort Wayne",
          "state": "IN",
          "zip_code": "46808"
        }
      },
      "property_details": {
        "heating_sources": [
          "furnace_electric"
        ],
        "has_barred_windows_over_50_percent": "Yes",
        "days_uninsured": 1,
        "builder_name": "Lennar Corp.",
        "fire_protection_class": "9",
        "address_info_s3_url": "s3://steadily-test-app-carlos/logs/2024/04/08/01HTZGD6ZKZK3F40VCGYW42N9I",
        "ca_dic_zone": "ineligible",
        "foundation_type": "concrete_slab",
        "garages": [
          {
            "size": "2"
          }
        ],
        "average_wall_height_feet": 9,
        "bathroom_details": [
          {
            "type": "Full"
          }
        ],
        "bedrooms": 3,
        "fireplaces": 1
      },
      "additional_insured": [
        {
          "loan_number": "JPM98765,12345",
          "address": {
            "street_address": "4825 Mount Sinyala Crossover",
            "city": "Fort Wayne",
            "state": "IN",
            "zip_code": "46808"
          }
        }
      ]
    }
  ],
  "policy_coverages": [
    {
      "name": "water_damage_limitation",
      "config": [
        {
          "type": "limit",
          "label": "Water Damage Limitation",
          "value": "10%"
        },
        {
          "type": "sublimit",
          "label": "Water Damage Limitation - Fungi Rot Sublimit",
          "value": "5000"
        }
      ]
    }
  ],
  "payment": {
    "schedule": "full"
  },
  "quote_id": "qte_100034386"
}

Response

Successful Response

policy_type'DP1' | 'DP2' | 'DP3' required

An enumeration.

insurance_structure'COI_MASTER_MGA' | 'STANDARD_MGA' | 'XMGA' | 'ARCHIVED'

An enumeration.

effective_datestring date

Effective date in YYYY-MM-DD format. Defaults to today.

effective_date_timezonestring nullable
updated_atstring date-time nullable
previous_policy_idstring nullable
renewal_policy_idstring nullable
renewal_quote_idstring nullable
renewal_status'draft' | 'quoted' | 'bound' | 'invalidated'

An enumeration.

renewal_start_datestring date nullable
renewal_end_datestring date nullable
agent_ui_urlstring nullable

Direct link to Agent UI, which can be used to complete quote.

carrierstring required
public_policy_idstring nullable required
quote_idstring required
public_quote_idstring required
status'draft' | 'quoted' | 'declined' | 'bound' | 'issued' required

An enumeration.

insurance_score_messagesobject[] nullable