> ## 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 Zone Terms

> Updates the terms for a single zone (e.g. `CA`, `Tier1`, `AllOther`) within a coverage option's peril class. `peril_group` links the zone to the peril group whose subperils it applies to; pass its `uuid`, or `null` to clear the association.



## OpenAPI

````yaml https://vision.dev.pingintel.com/api/schema/?format=json patch /api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_uuid}/zones/{zone_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}/zones/{zone_uuid}:
    patch:
      tags:
        - CAT Modeling
      summary: Update Zone Terms
      description: >-
        Updates the terms for a single zone (e.g. `CA`, `Tier1`, `AllOther`)
        within a coverage option's peril class. `peril_group` links the zone to
        the peril group whose subperils it applies to; pass its `uuid`, or
        `null` to clear the association.
      operationId: api_v1_submission_cat_coverage_options_zones_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: zone_uuid
          schema:
            type: string
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedZoneUpdate'
            examples:
              UpdateRequest:
                value:
                  included: true
                  sublimit: 3000000
                  per_location_deductible: 10
                  per_location_deductible_type: S
                  per_location_deductible_format: P
                  bi_days_deductible: 5
                  peril_group: 019dd58e-eb2a-7958-8070-570003e4ee51
                summary: Update request
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedZoneUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedZoneUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyTermsZone'
              examples:
                Updated:
                  value:
                    uuid: 019dd58e-eb2a-7958-8070-570003e4ee60
                    zone: Tier1
                    peril_class: HU
                    included: true
                    sublimit: 3000000
                    per_location_deductible: 10
                    per_location_deductible_type: S
                    per_location_deductible_format: P
                    min_deductible: null
                    max_deductible: null
                    deductible_type: null
                    tiv: null
                    location_count: 0
                    bi_days_deductible: 5
                    peril_group_uuid: 019dd58e-eb2a-7958-8070-570003e4ee51
          description: ''
      security:
        - authorization_header: []
components:
  schemas:
    PatchedZoneUpdate:
      type: object
      properties:
        bi_days_deductible:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        included:
          type: boolean
        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
        per_location_deductible:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          nullable: true
        per_location_deductible_format:
          enum:
            - P
            - C
            - ''
            - null
          type: string
          x-spec-enum-id: 1453737de42163e5
          nullable: true
          description: |-
            Percent or dollar?

            * `P` - Percentage
            * `C` - Currency
        per_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
        peril_group:
          type: string
          format: uuid
          nullable: true
          description: UUID of the peril group
        sublimit:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          nullable: true
    PolicyTermsZone:
      type: object
      properties:
        bi_days_deductible:
          type: integer
          readOnly: true
          nullable: true
        deductible_type:
          type: string
          readOnly: true
          nullable: true
        included:
          type: boolean
          readOnly: true
        location_count:
          type: integer
          readOnly: true
          nullable: true
          description: >-
            Number of locations that fall under this zone. Should be calculated
            on change.
        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
        per_location_deductible:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        per_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
        per_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
        peril_class:
          enum:
            - HU
            - EQ
            - IF
            - SCS
            - AOP
            - WF
            - TE
            - NC
          type: string
          description: |-
            * `HU` - Hu
            * `EQ` - Eq
            * `IF` - Flood
            * `SCS` - Severeconvectivestorm
            * `AOP` - Aop
            * `WF` - Wildfire
            * `TE` - Terrorism
            * `NC` - Noncat
          x-spec-enum-id: b72e536a6e65a035
          readOnly: true
        peril_group_uuid:
          type: string
          readOnly: true
        sublimit:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        tiv:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
          description: Total Insured Value for this zone.
        uuid:
          type: string
          format: uuid
          readOnly: true
          nullable: true
          description: UUID of the zone
        zone:
          enum:
            - TriCounty
            - Tier1
            - Tier1 TX-VA
            - Tier1 TX-NC
            - Tier1 MD-ME
            - Tier1 VA-ME
            - Tier2
            - AK
            - CA
            - CO
            - FL
            - HI
            - OK
            - NewMadrid
            - PacNW
            - PR
            - TX
            - Inland TX
            - SFHA
            - MFHA
            - High Hazard
            - AllOther
            - Unknown
            - Custom1
            - Custom2
            - Custom3
            - Custom4
            - null
          type: string
          description: |-
            * `TriCounty` - Tricounty
            * `Tier1` - Tier1
            * `Tier1 TX-VA` - Tier1Txtova
            * `Tier1 TX-NC` - Tier1Txtonc
            * `Tier1 MD-ME` - Tier1Mdtome
            * `Tier1 VA-ME` - Tier1Vatome
            * `Tier2` - Tier2
            * `AK` - Ak
            * `CA` - Ca
            * `CO` - Co
            * `FL` - Fl
            * `HI` - Hi
            * `OK` - Ok
            * `NewMadrid` - Newmadrid
            * `PacNW` - Pacnw
            * `PR` - Pr
            * `TX` - Tx
            * `Inland TX` - Inlandtexas
            * `SFHA` - Sfha
            * `MFHA` - Mfha
            * `High Hazard` - Highhazard
            * `AllOther` - Allother
            * `Unknown` - Unknown
            * `Custom1` - Custom1
            * `Custom2` - Custom2
            * `Custom3` - Custom3
            * `Custom4` - Custom4
          x-spec-enum-id: 796960033c99fd8c
          readOnly: true
          nullable: true
      required:
        - bi_days_deductible
        - deductible_type
        - included
        - location_count
        - max_deductible
        - min_deductible
        - per_location_deductible
        - per_location_deductible_format
        - per_location_deductible_type
        - peril_class
        - peril_group_uuid
        - sublimit
        - tiv
        - uuid
        - zone
  securitySchemes:
    authorization_header:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Supports `Token `-prefixed API keys and `Bearer `-prefixed JWT-based
        authentication.

````