> ## Documentation Index > Fetch the complete documentation index at: https://docs.pingintel.com/llms.txt > Use this file to discover all available pages before exploring further. # Update Peril Group > Updates a peril group's terms. `is_deductible_combined` and `is_sublimit_combined` can only be changed when `is_bi_split_allowed=true`; switching either toggles which deductible/sublimit fields (combined `min_deductible`/`max_deductible`/`sublimit` vs. split `pd_*`/`bi_*` variants) are accepted on subsequent updates. `display_name` must be unique on the coverage option. ## OpenAPI ````yaml https://vision.dev.pingintel.com/api/schema/?format=json patch /api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/peril-groups/{group_uuid} openapi: 3.0.3 info: title: Ping.Vision API version: v1.0 description: > ### Ping.Vision API This API provides convenient, efficient access to Ping Intel's data and services. It is designed to be used by developers and data scientists to integrate Ping Intel's capabilities into their applications. Once SSO is set up with your organization, you can create an Organization or Personal API key at https://auth.pingintel.com/org. Please see the Python client library [pingintel-api](https://pypi.org/project/pingintel-api/) for commandline tools and programmatic access, and you can refer to the following documentation for details on interacting with the system via the HTTP API. contact: email: support@pingintel.com name: Ping Intel url: https://www.pingintel.com servers: - url: https://vision.pingintel.com description: Ping.Vision API - url: https://vision.staging.pingintel.com description: Ping.Vision API (staging) security: [] tags: - name: Create Submission description: The Create Submission API allows you to add new data into the system. - name: Update Submission description: >- The Update Submission API provides various endpoints to update, modify, or act upon existing submissions. - name: Get Submission Data description: '' - name: User Memberships description: >- The User Memberships API allows you to add, remove, and change the role of users in different teams, divisions, or companies. - name: Miscellaneous description: '' paths: /api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/peril-groups/{group_uuid}: patch: tags: - CAT Modeling summary: Update Peril Group description: >- Updates a peril group's terms. `is_deductible_combined` and `is_sublimit_combined` can only be changed when `is_bi_split_allowed=true`; switching either toggles which deductible/sublimit fields (combined `min_deductible`/`max_deductible`/`sublimit` vs. split `pd_*`/`bi_*` variants) are accepted on subsequent updates. `display_name` must be unique on the coverage option. operationId: api_v1_submission_cat_coverage_options_peril_groups_partial_update parameters: - in: path name: coverage_option_uuid schema: type: string required: true - in: path name: group_uuid schema: type: string required: true - in: path name: pingid schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPerilGroupUpdate' examples: UpdateRequest: value: sublimit: 1500000 summary: Update request application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedPerilGroupUpdate' multipart/form-data: schema: $ref: '#/components/schemas/PatchedPerilGroupUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PolicyTermsPerilGroup' examples: Updated: value: uuid: 019dd58e-eb2a-7958-8070-570003e4ee51 section_name: Earthquake section_uuid: 019dd58e-eb2a-7958-8070-570003e4ee50 display_name: Earthquake group_label: EQ is_user_created: false included: true bi_days_deductible: 10 min_deductible: 10000 max_deductible: 20000 sublimit: 1500000 self_insured_retentions: 100000 agg_limit: 500000 agg_deductible: 50000 location_deductible_format: C location_deductible_type: S location_deductible: 25000 is_bi_split_allowed: true is_sublimit_combined: true bi_sublimit: null pd_sublimit: null is_deductible_combined: true pd_min_deductible: null pd_max_deductible: null pd_location_deductible_format: null pd_location_deductible: null bi_min_deductible: null bi_max_deductible: null bi_location_deductible_format: null bi_location_deductible: null subperils: [] description: '' security: - authorization_header: [] components: schemas: PatchedPerilGroupUpdate: type: object properties: agg_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true agg_limit: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true bi_days_deductible: type: integer maximum: 2147483647 minimum: 0 nullable: true bi_location_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true bi_location_deductible_format: enum: - P - C - '' - null type: string x-spec-enum-id: 1453737de42163e5 nullable: true description: |- Percent or dollar? * `P` - Percentage * `C` - Currency bi_max_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true bi_min_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true bi_sublimit: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true display_name: type: string nullable: true description: >- Display name for the peril group, e.g., Earthquake, Earthquake 2, Hurricane, etc. maxLength: 50 included: type: boolean is_bi_split_allowed: type: boolean readOnly: true nullable: true is_deductible_combined: type: boolean nullable: true is_sublimit_combined: type: boolean nullable: true location_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true location_deductible_format: enum: - P - C - '' - null type: string x-spec-enum-id: 1453737de42163e5 nullable: true description: |- Percent or dollar? * `P` - Percentage * `C` - Currency location_deductible_type: enum: - S - C - CT - CB - PL - '' - null type: string description: |- * `S` - Sitedeductible * `C` - Perunitcoverage * `CT` - Combinedwithtimeelement * `CB` - Applytopropertydamage * `PL` - Percentofloss x-spec-enum-id: c999e4d4dffff517 nullable: true max_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true min_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true pd_building_location_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true pd_building_location_deductible_format: enum: - P - C - '' - null type: string x-spec-enum-id: 1453737de42163e5 nullable: true description: |- Percent or dollar? * `P` - Percentage * `C` - Currency pd_contents_location_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true pd_contents_location_deductible_format: enum: - P - C - '' - null type: string x-spec-enum-id: 1453737de42163e5 nullable: true description: |- Percent or dollar? * `P` - Percentage * `C` - Currency pd_max_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true pd_min_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true pd_sublimit: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true self_insured_retentions: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true sublimit: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ nullable: true PolicyTermsPerilGroup: type: object properties: agg_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true agg_limit: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true bi_days_deductible: type: integer readOnly: true nullable: true bi_location_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true bi_location_deductible_format: enum: - P - C - null type: string x-spec-enum-id: 1453737de42163e5 readOnly: true nullable: true description: |- Percent or dollar? * `P` - Percentage * `C` - Currency bi_max_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true bi_min_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true bi_sublimit: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true display_name: type: string readOnly: true nullable: true description: >- Display name for the peril group, e.g., Earthquake, Earthquake 2, Hurricane, etc. group_label: type: string readOnly: true description: Peril group label, e.g., EQ, EQ2, HU, IF, etc. included: type: boolean readOnly: true is_bi_split_allowed: type: boolean readOnly: true nullable: true is_deductible_combined: type: boolean readOnly: true nullable: true is_sublimit_combined: type: boolean readOnly: true nullable: true is_user_created: type: boolean readOnly: true nullable: true description: If user created this, set to True. location_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true location_deductible_format: enum: - P - C - null type: string x-spec-enum-id: 1453737de42163e5 readOnly: true nullable: true description: |- Percent or dollar? * `P` - Percentage * `C` - Currency location_deductible_type: enum: - S - C - CT - CB - PL - null type: string description: |- * `S` - Sitedeductible * `C` - Perunitcoverage * `CT` - Combinedwithtimeelement * `CB` - Applytopropertydamage * `PL` - Percentofloss x-spec-enum-id: c999e4d4dffff517 readOnly: true nullable: true max_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true min_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true pd_building_location_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true pd_building_location_deductible_format: enum: - P - C - null type: string x-spec-enum-id: 1453737de42163e5 readOnly: true nullable: true description: |- Percent or dollar? * `P` - Percentage * `C` - Currency pd_contents_location_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true pd_contents_location_deductible_format: enum: - P - C - null type: string x-spec-enum-id: 1453737de42163e5 readOnly: true nullable: true description: |- Percent or dollar? * `P` - Percentage * `C` - Currency pd_max_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true pd_min_deductible: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true pd_sublimit: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true section_name: type: string section_uuid: type: string format: uuid self_insured_retentions: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true sublimit: type: string format: decimal pattern: ^-?\d{0,18}(?:\.\d{0,2})?$ readOnly: true nullable: true subperils: type: array items: $ref: '#/components/schemas/PolicyTermsSubperil' uuid: type: string format: uuid readOnly: true nullable: true description: UUID of the peril group required: - agg_deductible - agg_limit - bi_days_deductible - bi_location_deductible - bi_location_deductible_format - bi_max_deductible - bi_min_deductible - bi_sublimit - display_name - group_label - included - is_bi_split_allowed - is_deductible_combined - is_sublimit_combined - is_user_created - location_deductible - location_deductible_format - location_deductible_type - max_deductible - min_deductible - pd_building_location_deductible - pd_building_location_deductible_format - pd_contents_location_deductible - pd_contents_location_deductible_format - pd_max_deductible - pd_min_deductible - pd_sublimit - section_name - section_uuid - self_insured_retentions - sublimit - subperils - uuid PolicyTermsSubperil: type: object properties: allowed_peril_groups: type: array items: type: string maxLength: 20 readOnly: true description: List of allowed peril groups, if applicable. included: type: boolean readOnly: true name: type: string readOnly: true peril_group_uuid: type: string format: uuid peril_type: enum: - HU_Wind - HU_Surge - HU_PrecipitationFlood - EQ_Shake - EQ_Fire - EQ_Sprinkler - EQ_Landslide - EQ_Tsunami - EQ_Liquefaction - InlandFlood - Wildfire - Smoke - WinterStorm - SevereConvectiveStorm - Hail - StraightLineWind - Tornado - SevereStorm - Terrorism - NonCat type: string description: |- * `HU_Wind` - Hu_Wind * `HU_Surge` - Hu_Surge * `HU_PrecipitationFlood` - Hu_Precipitationflood * `EQ_Shake` - Eq_Shake * `EQ_Fire` - Eq_Fire * `EQ_Sprinkler` - Eq_Sprinkler * `EQ_Landslide` - Eq_Landslide * `EQ_Tsunami` - Eq_Tsunami * `EQ_Liquefaction` - Eq_Liquefaction * `InlandFlood` - Inlandflood * `Wildfire` - Wildfire * `Smoke` - Wf_Smoke * `WinterStorm` - Winterstorm * `SevereConvectiveStorm` - Severeconvectivestorm * `Hail` - Hail * `StraightLineWind` - Straightlinewind * `Tornado` - Tornado * `SevereStorm` - Severestorm * `Terrorism` - Terrorism * `NonCat` - Noncat x-spec-enum-id: 0ee0d83a25944b26 readOnly: true uuid: type: string format: uuid readOnly: true nullable: true description: UUID of the subperil required: - allowed_peril_groups - included - name - peril_group_uuid - peril_type - uuid securitySchemes: authorization_header: type: apiKey in: header name: Authorization description: >- Supports `Token `-prefixed API keys and `Bearer `-prefixed JWT-based authentication. ````