quick_quote_templates

Download schema

add_template_to_policy_type

POST

/api/v2/quick_quote_templates/add_template_to_policy_type

Associate a Quick Quote Template with a Policy Type

add_template_to_policy_type › Request Body

Request schema for /api/v2/quick_quote_templates/add_template_to_policy_type

request-add_template_to_policy_type

policy_type_id

string · uuid · required

The ID of the policy type

quick_quote_template_id

string · uuid · required

The ID of the Quick Quote Template to associate

add_template_to_policy_type › Responses

200

Response schema for /api/v2/quick_quote_templates/add_template_to_policy_type

response-add_template_to_policy_type

object · required

The created association between template and policy type

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/quick_quote_templates/add_template_to_policy_type

curl --request POST \
  --url /api/v2/quick_quote_templates/add_template_to_policy_type \
  --header 'Content-Type: application/json' \
  --data '
{
  "policy_type_id": "00000000-0000-0000-0000-000000000000",
  "quick_quote_template_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "policy_type_id": "00000000-0000-0000-0000-000000000000",
  "quick_quote_template_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "policy_type_id": "00000000-0000-0000-0000-000000000000",
    "quick_quote_template_id": "00000000-0000-0000-0000-000000000000"
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

create_quick_quote_template

POST

/api/v2/quick_quote_templates/create_quick_quote_template

Create a new Quick Quote Template

create_quick_quote_template › Request Body

Request schema for /api/v2/quick_quote_templates/create_quick_quote_template

request-create_quick_quote_template

name

string · minLength: 1 · maxLength: 250 · required

The name of the Quick Quote Template

object · required

Quote-wide data containing coverage items

policy_type_ids

string[]

List of policy type IDs to associate with this template

create_quick_quote_template › Responses

200

Response schema for /api/v2/quick_quote_templates/create_quick_quote_template

response-create_quick_quote_template

object · required

The created Quick Quote Template

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/quick_quote_templates/create_quick_quote_template

curl --request POST \
  --url /api/v2/quick_quote_templates/create_quick_quote_template \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "quote_template": {
    "items": [
      {
        "id": "id",
        "name": "name",
        "limit1": 0,
        "limit1_type": "limit1_type",
        "limit2": 0,
        "limit2_type": "limit2_type",
        "limit3": 0,
        "limit3_type": "limit3_type",
        "deductible": 0,
        "coverage_type_id": "coverage_type_id"
      }
    ]
  },
  "policy_type_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
'

Example Request Body

{
  "name": "name",
  "quote_template": {
    "items": [
      {
        "id": "id",
        "name": "name",
        "limit1": 0,
        "limit1_type": "limit1_type",
        "limit2": 0,
        "limit2_type": "limit2_type",
        "limit3": 0,
        "limit3_type": "limit3_type",
        "deductible": 0,
        "coverage_type_id": "coverage_type_id"
      }
    ]
  },
  "policy_type_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "quote_template": {
      "items": [
        {}
      ]
    },
    "template_risk_values": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "quick_quote_template_id": "00000000-0000-0000-0000-000000000000",
        "risk_defaults": {},
        "risk_type": "risk_type",
        "version": 0
      }
    ]
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

create_template_risk_default_value

POST

/api/v2/quick_quote_templates/create_template_risk_default_value

Create a new Template Risk Default Value

create_template_risk_default_value › Request Body

Request schema for /api/v2/quick_quote_templates/create_template_risk_default_value

request-create_template_risk_default_value

quick_quote_template_id

string · uuid · required

The ID of the Quick Quote Template this risk value belongs to

required

Risk-specific data structure that varies based on risk_type

risk_type

string · enum · required

The type of risk (Property, Vehicle, Driver, or Watercraft)

Enum values:

Property

Vehicle

Driver

Watercraft

version

integer

Version number for the risk default value

Default: 1

create_template_risk_default_value › Responses

200

Response schema for /api/v2/quick_quote_templates/create_template_risk_default_value

response-create_template_risk_default_value

object · required

The created Template Risk Default Value

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/quick_quote_templates/create_template_risk_default_value

curl --request POST \
  --url /api/v2/quick_quote_templates/create_template_risk_default_value \
  --header 'Content-Type: application/json' \
  --data '
{
  "quick_quote_template_id": "00000000-0000-0000-0000-000000000000",
  "risk_defaults": {
    "address_city": "address_city",
    "address_county": "address_county",
    "address_line1": "address_line1",
    "address_line2": "address_line2",
    "address_state": "address_state",
    "address_zip": "address_zip",
    "year_built": "year_built",
    "stories": "stories",
    "square_footage": 0
  },
  "risk_type": "Property",
  "version": 1
}
'

Example Request Body

{
  "quick_quote_template_id": "00000000-0000-0000-0000-000000000000",
  "risk_defaults": {
    "address_city": "address_city",
    "address_county": "address_county",
    "address_line1": "address_line1",
    "address_line2": "address_line2",
    "address_state": "address_state",
    "address_zip": "address_zip",
    "year_built": "year_built",
    "stories": "stories",
    "square_footage": 0
  },
  "risk_type": "Property",
  "version": 1
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "quick_quote_template_id": "00000000-0000-0000-0000-000000000000",
    "risk_defaults": {},
    "risk_type": "Property",
    "version": 0
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

delete_quick_quote_template

POST

/api/v2/quick_quote_templates/delete_quick_quote_template

Delete a Quick Quote Template

delete_quick_quote_template › Request Body

Request schema for /api/v2/quick_quote_templates/delete_quick_quote_template

request-delete_quick_quote_template

template_id

string · uuid · required

The ID of the Quick Quote Template to delete

delete_quick_quote_template › Responses

200

Response schema for /api/v2/quick_quote_templates/delete_quick_quote_template

response-delete_quick_quote_template

object · required

Success message for template deletion

success

boolean · required

Indicates if the request was successful

required

delete_template_risk_default_value

POST

/api/v2/quick_quote_templates/delete_template_risk_default_value

Delete a Template Risk Default Value

delete_template_risk_default_value › Request Body

Request schema for /api/v2/quick_quote_templates/delete_template_risk_default_value

request-delete_template_risk_default_value

value_id

string · uuid · required

The ID of the Template Risk Default Value to delete

delete_template_risk_default_value › Responses

200

Response schema for /api/v2/quick_quote_templates/delete_template_risk_default_value

response-delete_template_risk_default_value

object · required

Success message for risk default value deletion

success

boolean · required

Indicates if the request was successful

required

get_quick_quote_template

POST

/api/v2/quick_quote_templates/get_quick_quote_template

Get a Quick Quote Template by ID

get_quick_quote_template › Request Body

Request schema for /api/v2/quick_quote_templates/get_quick_quote_template

request-get_quick_quote_template

template_id

string · uuid · required

The ID of the Quick Quote Template to retrieve

get_quick_quote_template › Responses

200

Response schema for /api/v2/quick_quote_templates/get_quick_quote_template

response-get_quick_quote_template

object · required

The requested Quick Quote Template

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/quick_quote_templates/get_quick_quote_template

curl --request POST \
  --url /api/v2/quick_quote_templates/get_quick_quote_template \
  --header 'Content-Type: application/json' \
  --data '
{
  "template_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "template_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "quote_template": {
      "items": [
        {}
      ]
    },
    "template_risk_values": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "quick_quote_template_id": "00000000-0000-0000-0000-000000000000",
        "risk_defaults": {},
        "risk_type": "risk_type",
        "version": 0
      }
    ]
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

list_quick_quote_templates

POST

/api/v2/quick_quote_templates/list_quick_quote_templates

List all Quick Quote Templates

list_quick_quote_templates › Request Body

Request schema for /api/v2/quick_quote_templates/list_quick_quote_templates

request-list_quick_quote_templates

list_quick_quote_templates › Responses

200

Response schema for /api/v2/quick_quote_templates/list_quick_quote_templates

response-list_quick_quote_templates

object[] · required

List of all Quick Quote Templates

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/quick_quote_templates/list_quick_quote_templates

curl --request POST \
  --url /api/v2/quick_quote_templates/list_quick_quote_templates \
  --header 'Content-Type: application/json' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "quote_template": {
        "items": [
          {}
        ]
      },
      "template_risk_values": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "quick_quote_template_id": "00000000-0000-0000-0000-000000000000",
          "risk_defaults": {},
          "risk_type": "risk_type",
          "version": 0
        }
      ],
      "policy_types": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "name",
          "effective_date": "2024-08-25",
          "effective_date_id": "00000000-0000-0000-0000-000000000000"
        }
      ]
    }
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

update_quick_quote_template

POST

/api/v2/quick_quote_templates/update_quick_quote_template

Update an existing Quick Quote Template

update_quick_quote_template › Request Body

At least one field besides 'id' must be provided for update

request-update_quick_quote_template

id

string · uuid · required

The ID of the Quick Quote Template to update

name

string · minLength: 1 · maxLength: 250

The name of the Quick Quote Template

object

Quote-wide data containing coverage items

object[]

List of template risk default values

policy_type_ids

string[]

List of policy type IDs to associate with this template

update_quick_quote_template › Responses

200

Response schema for /api/v2/quick_quote_templates/update_quick_quote_template

response-update_quick_quote_template

object · required

The updated Quick Quote Template

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/quick_quote_templates/update_quick_quote_template

curl --request POST \
  --url /api/v2/quick_quote_templates/update_quick_quote_template \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "quote_template": {
    "items": [
      {
        "id": "id",
        "name": "name",
        "limit1": 0,
        "limit1_type": "limit1_type",
        "limit2": 0,
        "limit2_type": "limit2_type",
        "limit3": 0,
        "limit3_type": "limit3_type",
        "deductible": 0,
        "coverage_type_id": "coverage_type_id"
      }
    ]
  },
  "template_risk_values": [
    {
      "risk_type": "risk_type",
      "risk_defaults": {}
    }
  ],
  "policy_type_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "quote_template": {
    "items": [
      {
        "id": "id",
        "name": "name",
        "limit1": 0,
        "limit1_type": "limit1_type",
        "limit2": 0,
        "limit2_type": "limit2_type",
        "limit3": 0,
        "limit3_type": "limit3_type",
        "deductible": 0,
        "coverage_type_id": "coverage_type_id"
      }
    ]
  },
  "template_risk_values": [
    {
      "risk_type": "risk_type",
      "risk_defaults": {}
    }
  ],
  "policy_type_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "quote_template": {
      "items": [
        {}
      ]
    },
    "template_risk_values": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "quick_quote_template_id": "00000000-0000-0000-0000-000000000000",
        "risk_defaults": {},
        "risk_type": "risk_type",
        "version": 0
      }
    ],
    "policy_type_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

update_template_risk_default_value

POST

/api/v2/quick_quote_templates/update_template_risk_default_value

Update an existing Template Risk Default Value

update_template_risk_default_value › Request Body

update_template_risk_default_value › Responses

200

success

boolean

message

string[]

data

object

quick_codes quote