Skip to main content
PUT

Authorizations

Authorization
string
header
required

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

Path Parameters

pingid
string
required
uuid
string
required

Body

The complete state of a coverage option: its own fields, every peril group, every zone.

bi_limit_type
enum<string>
required

GE: Gross Earnings. GP: Gross Profits.

  • GE - Gross Earnings
  • GP - Gross Profits
Available options:
GE,
GP
name
string
required

Name of the coverage option.

per_zone_terms
object[]
required

Every zone on this coverage option. Required.

peril_terms
object[]
required

Every peril group on this coverage option. Required.

annual_aggregate_deductible
string<decimal> | null

Annual aggregate deductible. Omit to clear it.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
annual_aggregate_per_occ_deductible
string<decimal> | null

Annual aggregate per occurrence deductible. Omit to clear it.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
annual_aggregate_per_occ_max
string<decimal> | null

Annual aggregate per occurrence maximum. Omit to clear it.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
annual_aggregate_trailing_deductible
string<decimal> | null

Annual aggregate trailing deductible. Omit to clear it.

Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
default_bi_period_days
integer | null

Default BI period in days. Omit to clear it.

uuid
string<uuid>

UUID of the coverage option. Optional -- the URL identifies it. When supplied it must match, which guards a client with several options loaded against a mis-targeted save.

Response

The updated coverage option, in the same shape as Get Coverage Option, minus policy_terms_config and each subperil's allowed_peril_groups.

The detail representation, minus what a bulk update can neither change nor is asked for.

policy_terms_config is dropped (this endpoint never touches it), as is each subperil's allowed_peril_groups.

annual_aggregate_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
annual_aggregate_per_occ_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
annual_aggregate_per_occ_max
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
annual_aggregate_trailing_deductible
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
bi_limit_type
enum<string> | null
required
read-only
  • GE - Gross Earnings
  • GP - Gross Profits
Available options:
GE,
GP,
null
created_time
string<date-time>
required
read-only
default_bi_period_days
integer | null
required
read-only
modified_time
string<date-time> | null
required
read-only
name
string | null
required
read-only
per_zone_terms
object[]
required
peril_sections
object[]
required
uuid
string<uuid> | null
required
read-only

UUID of the policy terms coverage option

zone_set_name
string
required
read-only
extra_data
any | null

Extra data in JSON format.

zone_set
string<uuid> | null

UUID of the zone set associated with this coverage option.