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

> Sets whether a subperil is included in coverage. Excluded subperils are dropped from the peril group's coverage and reported in `excluded_subperil_types` on export endpoints.



## OpenAPI

````yaml https://vision.dev.pingintel.com/api/schema/?format=json patch /api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/subperils/{subperil_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}/subperils/{subperil_uuid}:
    patch:
      tags:
        - CAT Modeling
      summary: Update Subperil
      description: >-
        Sets whether a subperil is included in coverage. Excluded subperils are
        dropped from the peril group's coverage and reported in
        `excluded_subperil_types` on export endpoints.
      operationId: api_v1_submission_cat_coverage_options_subperils_partial_update
      parameters:
        - in: path
          name: coverage_option_uuid
          schema:
            type: string
          required: true
        - in: path
          name: pingid
          schema:
            type: string
          required: true
        - in: path
          name: subperil_uuid
          schema:
            type: string
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSubperilUpdate'
            examples:
              UpdateRequest:
                value:
                  included: false
                summary: Update request
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSubperilUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSubperilUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyTermsSubperil'
              examples:
                Updated:
                  value:
                    uuid: 019dd58e-eb2a-7958-8070-570003e4ee52
                    name: Landslide
                    included: false
                    peril_type: EQ_Landslide
                    peril_group_uuid: 019dd58e-eb2a-7958-8070-570003e4ee51
                    allowed_peril_groups:
                      - EQ
                      - EQ2
          description: ''
      security:
        - authorization_header: []
components:
  schemas:
    PatchedSubperilUpdate:
      type: object
      properties:
        included:
          type: boolean
    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.

````