> ## 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 Coverage Option

> Updates the details of a coverage option. 



## OpenAPI

````yaml https://vision.dev.pingintel.com/api/schema/?format=json patch /api/v1/submission/{pingid}/cat/coverage-options/{coverage_option_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}:
    patch:
      tags:
        - CAT Modeling
      summary: Update Coverage Option
      description: 'Updates the details of a coverage option. '
      operationId: api_v1_submission_cat_coverage_options_partial_update
      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/PatchedCoverageOptionUpdate'
            examples:
              UpdateRequest:
                value:
                  name: Option 1 (renamed)
                  bi_limit_type: GP
                  default_bi_period_days: 30
                summary: Update request
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCoverageOptionUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCoverageOptionUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoverageOptionList'
              examples:
                Updated:
                  value:
                    uuid: 019dd58e-eb2a-7958-8070-570003e4ee29
                    name: Option 1 (renamed)
                    created_time: '2026-04-29T02:10:34.749499Z'
                    modified_time: '2026-04-29T03:00:00.000000Z'
                    bi_limit_type: GP
                    default_bi_period_days: 30
          description: ''
      security:
        - authorization_header: []
components:
  schemas:
    PatchedCoverageOptionUpdate:
      type: object
      properties:
        bi_limit_type:
          enum:
            - GE
            - GP
          type: string
          x-spec-enum-id: f81ee74b088734af
          description: |-
            GE: Gross Earnings. GP: Gross Profits.

            * `GE` - Gross Earnings
            * `GP` - Gross Profits
        default_bi_period_days:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
        name:
          type: string
    CoverageOptionList:
      type: object
      properties:
        created_time:
          type: string
          format: date-time
          description: When the coverage option was created.
        modified_time:
          type: string
          format: date-time
          description: When any of the terms in this coverage option were last modified.
        name:
          type: string
          description: Coverage option name.
        uuid:
          type: string
          format: uuid
          description: Coverage option identifier.
        bi_limit_type:
          enum:
            - GE
            - GP
            - null
          type: string
          x-spec-enum-id: f81ee74b088734af
          nullable: true
          description: >-
            Business interruption limit type. `GE`: Gross Earnings. `GP`: Gross
            Profits.


            * `GE` - Gross Earnings

            * `GP` - Gross Profits
        default_bi_period_days:
          type: integer
          nullable: true
          description: Default BI waiting period in days.
      required:
        - created_time
        - modified_time
        - name
        - uuid
  securitySchemes:
    authorization_header:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Supports `Token `-prefixed API keys and `Bearer `-prefixed JWT-based
        authentication.

````