Skip to main content
PATCH
Update Peril Group

Authorizations

Authorization
string
header
required

Supports Token-prefixed API keys and Bearer-prefixed JWT-based authentication.

Path Parameters

coverage_option_uuid
string
required
group_uuid
string
required
pingid
string
required

Body

agg_deductible
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
agg_limit
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
bi_days_deductible
integer | null
Required range: 0 <= x <= 2147483647
bi_location_deductible
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
bi_location_deductible_format
enum<string> | null

Percent or dollar?

  • P - Percentage
  • C - Currency
Available options:
P,
C,
,
null
bi_max_deductible
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
bi_min_deductible
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
bi_sublimit
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
display_name
string | null

Display name for the peril group, e.g., Earthquake, Earthquake 2, Hurricane, etc.

Maximum string length: 50
included
boolean
is_deductible_combined
boolean | null
is_sublimit_combined
boolean | null
location_deductible
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
location_deductible_format
enum<string> | null

Percent or dollar?

  • P - Percentage
  • C - Currency
Available options:
P,
C,
,
null
location_deductible_type
enum<string> | null
  • S - Sitedeductible
  • C - Perunitcoverage
  • CT - Combinedwithtimeelement
  • CB - Applytopropertydamage
  • PL - Percentofloss
Available options:
S,
C,
CT,
CB,
PL,
,
null
max_deductible
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
min_deductible
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
pd_building_location_deductible
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
pd_building_location_deductible_format
enum<string> | null

Percent or dollar?

  • P - Percentage
  • C - Currency
Available options:
P,
C,
,
null
pd_contents_location_deductible
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
pd_contents_location_deductible_format
enum<string> | null

Percent or dollar?

  • P - Percentage
  • C - Currency
Available options:
P,
C,
,
null
pd_max_deductible
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
pd_min_deductible
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
pd_sublimit
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
self_insured_retentions
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
sublimit
string<decimal> | null
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$

Response

200 - application/json
agg_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
agg_limit
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
bi_days_deductible
integer | null
required
read-only
bi_location_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
bi_location_deductible_format
enum<string> | null
required
read-only

Percent or dollar?

  • P - Percentage
  • C - Currency
Available options:
P,
C,
null
bi_max_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
bi_min_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
bi_sublimit
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
display_name
string | null
required
read-only

Display name for the peril group, e.g., Earthquake, Earthquake 2, Hurricane, etc.

group_label
string
required
read-only

Peril group label, e.g., EQ, EQ2, HU, IF, etc.

included
boolean
required
read-only
is_bi_split_allowed
boolean | null
required
read-only
is_deductible_combined
boolean | null
required
read-only
is_sublimit_combined
boolean | null
required
read-only
is_user_created
boolean | null
required
read-only

If user created this, set to True.

location_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
location_deductible_format
enum<string> | null
required
read-only

Percent or dollar?

  • P - Percentage
  • C - Currency
Available options:
P,
C,
null
location_deductible_type
enum<string> | null
required
read-only
  • S - Sitedeductible
  • C - Perunitcoverage
  • CT - Combinedwithtimeelement
  • CB - Applytopropertydamage
  • PL - Percentofloss
Available options:
S,
C,
CT,
CB,
PL,
null
max_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
min_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
pd_building_location_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
pd_building_location_deductible_format
enum<string> | null
required
read-only

Percent or dollar?

  • P - Percentage
  • C - Currency
Available options:
P,
C,
null
pd_contents_location_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
pd_contents_location_deductible_format
enum<string> | null
required
read-only

Percent or dollar?

  • P - Percentage
  • C - Currency
Available options:
P,
C,
null
pd_max_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
pd_min_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
pd_sublimit
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
section_name
string
required
section_uuid
string<uuid>
required
self_insured_retentions
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
sublimit
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
subperils
object[]
required
uuid
string<uuid> | null
required
read-only

UUID of the peril group