> ## 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.

# Create Peril Group

> Creates a new, user-created peril group on a coverage option. `group_label` must be a label that at least one subperil on this coverage option allows via `allowed_peril_groups`, and must not already be in use — see <a href="#tag/CAT/operation/api_v1_internal_submissions_coverage_options_available_group_labels_retrieve">List available group labels</a>. `display_name` defaults to `group_label` if omitted, and must also be unique on the coverage option.



## OpenAPI

````yaml https://vision.dev.pingintel.com/api/schema/?format=json post /api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/peril-groups
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:
    post:
      tags:
        - CAT Modeling
      summary: Create Peril Group
      description: >-
        Creates a new, user-created peril group on a coverage option.
        `group_label` must be a label that at least one subperil on this
        coverage option allows via `allowed_peril_groups`, and must not already
        be in use — see <a
        href="#tag/CAT/operation/api_v1_internal_submissions_coverage_options_available_group_labels_retrieve">List
        available group labels</a>. `display_name` defaults to `group_label` if
        omitted, and must also be unique on the coverage option.
      operationId: api_v1_submission_cat_coverage_options_peril_groups_create
      parameters:
        - in: path
          name: coverage_option_uuid
          schema:
            type: string
          required: true
        - in: path
          name: pingid
          schema:
            type: string
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PerilGroupCreate'
            examples:
              CreateRequest:
                value:
                  group_label: EQ2
                  included: true
                summary: Create request
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PerilGroupCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PerilGroupCreate'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyTermsPerilGroup'
              examples:
                Created:
                  value:
                    uuid: 019dd58e-eb2a-7958-8070-570003e4ee90
                    section_name: Earthquake
                    section_uuid: 019dd58e-eb2a-7958-8070-570003e4ee50
                    display_name: EQ2
                    group_label: EQ2
                    is_user_created: true
                    included: true
                    bi_days_deductible: null
                    min_deductible: null
                    max_deductible: null
                    sublimit: null
                    self_insured_retentions: null
                    agg_limit: null
                    agg_deductible: null
                    location_deductible_format: null
                    location_deductible_type: null
                    location_deductible: null
                    is_bi_split_allowed: false
                    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:
    PerilGroupCreate:
      type: object
      properties:
        group_label:
          type: string
          description: Peril group label, e.g., EQ, EQ2, HU, IF, etc.
          maxLength: 20
        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
        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
        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
        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
      required:
        - group_label
    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.

````