> ## 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 Submission Document Details

> Update details of a submission document, such as renaming, changing type, or archiving.



## OpenAPI

````yaml https://vision.staging.pingintel.com/api/schema/?format=json patch /api/v1/submission/{id}/document/{filename}
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/{id}/document/{filename}:
    patch:
      tags:
        - Update Submission
      summary: Update Submission Document Details
      description: >-
        Update details of a submission document, such as renaming, changing
        type, or archiving.
      operationId: api_v1_submission_document_partial_update
      parameters:
        - in: path
          name: filename
          schema:
            type: string
          description: The filename of the document to update.
          required: true
        - in: path
          name: id
          schema:
            type: string
          description: The pingid of the submission.
          required: true
          examples:
            Example:
              value: p-lo-ping-abc123
              description: Example ping ID.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSubmissionDocumentUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionDocumentUpdate'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionDocumentUpdateError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionDocumentNotFoundError'
          description: ''
      security:
        - authorization_header: []
components:
  schemas:
    PatchedSubmissionDocumentUpdate:
      type: object
      properties:
        document_type:
          enum:
            - SOV
            - SOV_WORKING_FILE
            - LOSS_RUN
            - ACORD
            - PDF
            - UNKNOWN
            - SOVFIXER_JSON
            - SOVFIXER_SCRUBBER
            - SOVFIXER_OUTPUT
            - SOVFIXER_AIR_P_CSV
            - SOVFIXER_AIR_L_CSV
            - SOVFIXER_RMS_P_CSV
            - SOVFIXER_RMS_L_CSV
            - EML
            - MSG
            - EMAIL_HTML
            - EMAIL_BODY_HTML
            - EMAIL_BODY_TXT
            - OTHER
            - UFS_CSV
            - ''
            - null
          type: string
          description: |-
            * `SOV` - SOV
            * `SOV_WORKING_FILE` - SOV Working File
            * `LOSS_RUN` - Loss Run
            * `ACORD` - ACORD
            * `PDF` - PDF
            * `UNKNOWN` - Unknown
            * `SOVFIXER_JSON` - SOVFixer JSON
            * `SOVFIXER_SCRUBBER` - SOVFixer Scrubber
            * `SOVFIXER_OUTPUT` - SOVFixer Output
            * `SOVFIXER_AIR_P_CSV` - AIR Policy CSV
            * `SOVFIXER_AIR_L_CSV` - AIR Location CSV
            * `SOVFIXER_RMS_P_CSV` - RMS Policy CSV
            * `SOVFIXER_RMS_L_CSV` - RMS Location CSV
            * `EML` - EML
            * `MSG` - MSG
            * `EMAIL_HTML` - Email HTML
            * `EMAIL_BODY_HTML` - Email Body HTML
            * `EMAIL_BODY_TXT` - Email Body Text
            * `OTHER` - Other
            * `UFS_CSV` - UFS CSV
          x-spec-enum-id: 042fb957253d42d9
          nullable: true
        filename:
          type: string
          maxLength: 2000
        is_archived:
          type: boolean
          description: >-
            Set to true to archive the document. This is a soft delete, the
            document is not removed from the database.
    SubmissionDocumentUpdate:
      type: object
      properties:
        filename:
          type: string
          maxLength: 2000
        document_type:
          enum:
            - SOV
            - SOV_WORKING_FILE
            - LOSS_RUN
            - ACORD
            - PDF
            - UNKNOWN
            - SOVFIXER_JSON
            - SOVFIXER_SCRUBBER
            - SOVFIXER_OUTPUT
            - SOVFIXER_AIR_P_CSV
            - SOVFIXER_AIR_L_CSV
            - SOVFIXER_RMS_P_CSV
            - SOVFIXER_RMS_L_CSV
            - EML
            - MSG
            - EMAIL_HTML
            - EMAIL_BODY_HTML
            - EMAIL_BODY_TXT
            - OTHER
            - UFS_CSV
            - ''
            - null
          type: string
          description: |-
            * `SOV` - SOV
            * `SOV_WORKING_FILE` - SOV Working File
            * `LOSS_RUN` - Loss Run
            * `ACORD` - ACORD
            * `PDF` - PDF
            * `UNKNOWN` - Unknown
            * `SOVFIXER_JSON` - SOVFixer JSON
            * `SOVFIXER_SCRUBBER` - SOVFixer Scrubber
            * `SOVFIXER_OUTPUT` - SOVFixer Output
            * `SOVFIXER_AIR_P_CSV` - AIR Policy CSV
            * `SOVFIXER_AIR_L_CSV` - AIR Location CSV
            * `SOVFIXER_RMS_P_CSV` - RMS Policy CSV
            * `SOVFIXER_RMS_L_CSV` - RMS Location CSV
            * `EML` - EML
            * `MSG` - MSG
            * `EMAIL_HTML` - Email HTML
            * `EMAIL_BODY_HTML` - Email Body HTML
            * `EMAIL_BODY_TXT` - Email Body Text
            * `OTHER` - Other
            * `UFS_CSV` - UFS CSV
          x-spec-enum-id: 042fb957253d42d9
          nullable: true
        is_archived:
          type: boolean
          description: >-
            Set to true to archive the document. This is a soft delete, the
            document is not removed from the database.
      required:
        - filename
    SubmissionDocumentUpdateError:
      type: object
      properties:
        error:
          type: string
        errors:
          type: object
          additionalProperties: {}
      required:
        - error
        - errors
    SubmissionDocumentNotFoundError:
      type: object
      properties:
        detail:
          type: string
        error:
          type: string
      required:
        - detail
        - error
  securitySchemes:
    authorization_header:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Supports `Token `-prefixed API keys and `Bearer `-prefixed JWT-based
        authentication.

````