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

> Update properties of the submission. If you want to change the claimant or the workflow status, use v1/submission/bulkupdate instead.



## OpenAPI

````yaml https://vision.staging.pingintel.com/api/schema/?format=json patch /api/v1/submission/{id}
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}:
    patch:
      tags:
        - Update Submission
      summary: Update Submission Details
      description: >-
        Update properties of the submission. If you want to change the claimant
        or the workflow status, use v1/submission/bulkupdate instead.
      operationId: api_v1_submission_partial_update
      parameters:
        - 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/PatchedSubmissionTriage'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSubmissionTriage'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSubmissionTriage'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmissionTriage'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  field_name:
                    type: array
                    items:
                      type: string
                    description: List of errors for the field
                  another_field:
                    type: array
                    items:
                      type: string
                    description: List of errors for another field
                  non_field_errors:
                    type: array
                    items:
                      type: string
                    description: General errors not tied to a specific field
                  detail:
                    type: string
                    description: Error message detail
                additionalProperties:
                  type: array
                  items:
                    type: string
              examples:
                InvalidDataExample:
                  value:
                    field_name:
                      - This field is required.
                    another_field:
                      - Value must be a positive integer.
                    non_field_errors:
                      - Invalid request.
                  summary: Invalid Data Example
                DetailErrorExample:
                  value:
                    detail: This is the error message detail.
                  summary: Detail Error Example
          description: Validation error
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse401'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse403'
          description: ''
      security:
        - authorization_header: []
components:
  schemas:
    PatchedSubmissionTriage:
      type: object
      properties:
        broker_assistant_name:
          type: string
          nullable: true
          maxLength: 2000
        broker_city:
          type: string
          nullable: true
          maxLength: 2000
        broker_contact_name:
          type: string
          nullable: true
          maxLength: 2000
        broker_country:
          type: string
          nullable: true
          maxLength: 2000
        broker_email:
          type: string
          format: email
          nullable: true
          maxLength: 254
        broker_fein:
          type: string
          nullable: true
          maxLength: 2000
        broker_full_address:
          type: string
          readOnly: true
        broker_license_number:
          type: string
          nullable: true
          maxLength: 255
        broker_license_state:
          type: string
          nullable: true
          maxLength: 2000
        broker_name:
          type: string
          nullable: true
          maxLength: 255
        broker_phone:
          type: string
          nullable: true
          maxLength: 255
        broker_state:
          type: string
          nullable: true
          maxLength: 2000
        broker_street:
          type: string
          nullable: true
          maxLength: 2000
        broker_street2:
          type: string
          nullable: true
          maxLength: 2000
        broker_zip:
          type: string
          nullable: true
          maxLength: 2000
        cat_modeling_term_selectors_read_only:
          type: boolean
          readOnly: true
        ceding_company_assistant_name:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_city:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_country:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_name:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_state:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_street:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_street2:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_zip:
          type: string
          nullable: true
          maxLength: 255
        client_ref:
          type: string
          nullable: true
          maxLength: 2000
        expiration_date:
          type: string
          format: date
          nullable: true
        fac_re_broker_company_assistant_name:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_city:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_contact_name:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_country:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_name:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_state:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_street:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_street2:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_zip:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_assistant_name:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_city:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_contact_name:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_country:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_name:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_state:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_street:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_street2:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_zip:
          type: string
          nullable: true
          maxLength: 255
        home_state:
          type: string
          nullable: true
          maxLength: 255
        inception_date:
          type: string
          format: date
          nullable: true
        insured_business_description:
          type: string
          nullable: true
        insured_city:
          type: string
          nullable: true
          maxLength: 2000
        insured_contact_email:
          type: string
          format: email
          nullable: true
          maxLength: 254
        insured_contact_name:
          type: string
          nullable: true
          maxLength: 255
        insured_contact_phone:
          type: string
          nullable: true
          maxLength: 255
        insured_country:
          type: string
          nullable: true
          maxLength: 2000
        insured_fein:
          type: string
          nullable: true
          maxLength: 2000
        insured_gl_code:
          type: string
          nullable: true
          maxLength: 255
        insured_name:
          type: string
          nullable: true
          maxLength: 2000
        insured_ofac_status:
          enum:
            - 'N'
            - U
            - B
            - ''
            - null
          type: string
          description: |-
            * `N` - Not Run
            * `U` - Unblocked
            * `B` - Blocked
          x-spec-enum-id: 342495a23967419d
          nullable: true
        insured_sic:
          type: string
          nullable: true
          maxLength: 255
        insured_state:
          type: string
          nullable: true
          maxLength: 2000
        insured_street:
          type: string
          nullable: true
          maxLength: 2000
        insured_street2:
          type: string
          nullable: true
          maxLength: 2000
        insured_website:
          type: string
          nullable: true
          maxLength: 255
        insured_zip:
          type: string
          nullable: true
          maxLength: 2000
        is_building_data_ready:
          type: boolean
          nullable: true
        is_rush:
          type: boolean
          nullable: true
          description: A flag to indicate that this submission is a rush job.
        need_by_date:
          type: string
          format: date
          nullable: true
        new_renewal:
          enum:
            - New
            - Renewal
            - ''
            - null
          type: string
          x-spec-enum-id: 78c0846a92a6c1eb
          nullable: true
          description: |-
            Whether the submission is for a new policy or a renewal.

            * `New` - New
            * `Renewal` - Renewal
        num_buildings:
          type: integer
          readOnly: true
          nullable: true
          description: >-
            The number of buildings in the submission (denormalized from
            Location)
        primary_naics_code:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
          title: NAICS
          description: Primary NAICS code for the submission, denormalized from Location
        risk_summary:
          type: string
          nullable: true
          description: AI generated risk summary (generated by InsuredAgent())
          maxLength: 1000
        target_terms:
          type: string
          nullable: true
        underwriter_assistant_name:
          type: string
          nullable: true
          maxLength: 255
        underwriter_city:
          type: string
          nullable: true
          maxLength: 255
        underwriter_contact_name:
          type: string
          nullable: true
          maxLength: 255
        underwriter_country:
          type: string
          nullable: true
          maxLength: 255
        underwriter_name:
          type: string
          nullable: true
          maxLength: 255
        underwriter_state:
          type: string
          nullable: true
          maxLength: 255
        underwriter_street:
          type: string
          nullable: true
          maxLength: 255
        underwriter_street2:
          type: string
          nullable: true
          maxLength: 255
        underwriter_zip:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_assistant_name:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_city:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_contact_name:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_country:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_email:
          type: string
          format: email
          nullable: true
          maxLength: 255
        wholesale_broker_name:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_state:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_street:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_street2:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_zip:
          type: string
          nullable: true
          maxLength: 255
    SubmissionTriage:
      type: object
      properties:
        broker_full_address:
          type: string
          readOnly: true
        cat_modeling_term_selectors_read_only:
          type: boolean
          readOnly: true
        num_buildings:
          type: integer
          readOnly: true
          nullable: true
          description: >-
            The number of buildings in the submission (denormalized from
            Location)
        broker_assistant_name:
          type: string
          nullable: true
          maxLength: 2000
        broker_city:
          type: string
          nullable: true
          maxLength: 2000
        broker_contact_name:
          type: string
          nullable: true
          maxLength: 2000
        broker_country:
          type: string
          nullable: true
          maxLength: 2000
        broker_email:
          type: string
          format: email
          nullable: true
          maxLength: 254
        broker_fein:
          type: string
          nullable: true
          maxLength: 2000
        broker_license_number:
          type: string
          nullable: true
          maxLength: 255
        broker_license_state:
          type: string
          nullable: true
          maxLength: 2000
        broker_name:
          type: string
          nullable: true
          maxLength: 255
        broker_phone:
          type: string
          nullable: true
          maxLength: 255
        broker_state:
          type: string
          nullable: true
          maxLength: 2000
        broker_street:
          type: string
          nullable: true
          maxLength: 2000
        broker_street2:
          type: string
          nullable: true
          maxLength: 2000
        broker_zip:
          type: string
          nullable: true
          maxLength: 2000
        ceding_company_assistant_name:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_city:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_country:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_name:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_state:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_street:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_street2:
          type: string
          nullable: true
          maxLength: 255
        ceding_company_zip:
          type: string
          nullable: true
          maxLength: 255
        client_ref:
          type: string
          nullable: true
          maxLength: 2000
        expiration_date:
          type: string
          format: date
          nullable: true
        fac_re_broker_company_assistant_name:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_city:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_contact_name:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_country:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_name:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_state:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_street:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_street2:
          type: string
          nullable: true
          maxLength: 255
        fac_re_broker_company_zip:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_assistant_name:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_city:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_contact_name:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_country:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_name:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_state:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_street:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_street2:
          type: string
          nullable: true
          maxLength: 255
        fac_re_company_zip:
          type: string
          nullable: true
          maxLength: 255
        home_state:
          type: string
          nullable: true
          maxLength: 255
        inception_date:
          type: string
          format: date
          nullable: true
        insured_business_description:
          type: string
          nullable: true
        insured_city:
          type: string
          nullable: true
          maxLength: 2000
        insured_contact_email:
          type: string
          format: email
          nullable: true
          maxLength: 254
        insured_contact_name:
          type: string
          nullable: true
          maxLength: 255
        insured_contact_phone:
          type: string
          nullable: true
          maxLength: 255
        insured_country:
          type: string
          nullable: true
          maxLength: 2000
        insured_fein:
          type: string
          nullable: true
          maxLength: 2000
        insured_gl_code:
          type: string
          nullable: true
          maxLength: 255
        insured_name:
          type: string
          nullable: true
          maxLength: 2000
        insured_ofac_status:
          enum:
            - 'N'
            - U
            - B
            - ''
            - null
          type: string
          description: |-
            * `N` - Not Run
            * `U` - Unblocked
            * `B` - Blocked
          x-spec-enum-id: 342495a23967419d
          nullable: true
        insured_sic:
          type: string
          nullable: true
          maxLength: 255
        insured_state:
          type: string
          nullable: true
          maxLength: 2000
        insured_street:
          type: string
          nullable: true
          maxLength: 2000
        insured_street2:
          type: string
          nullable: true
          maxLength: 2000
        insured_website:
          type: string
          nullable: true
          maxLength: 255
        insured_zip:
          type: string
          nullable: true
          maxLength: 2000
        is_building_data_ready:
          type: boolean
          nullable: true
        is_rush:
          type: boolean
          nullable: true
          description: A flag to indicate that this submission is a rush job.
        need_by_date:
          type: string
          format: date
          nullable: true
        new_renewal:
          enum:
            - New
            - Renewal
            - ''
            - null
          type: string
          x-spec-enum-id: 78c0846a92a6c1eb
          nullable: true
          description: |-
            Whether the submission is for a new policy or a renewal.

            * `New` - New
            * `Renewal` - Renewal
        primary_naics_code:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
          title: NAICS
          description: Primary NAICS code for the submission, denormalized from Location
        risk_summary:
          type: string
          nullable: true
          description: AI generated risk summary (generated by InsuredAgent())
          maxLength: 1000
        target_terms:
          type: string
          nullable: true
        underwriter_assistant_name:
          type: string
          nullable: true
          maxLength: 255
        underwriter_city:
          type: string
          nullable: true
          maxLength: 255
        underwriter_contact_name:
          type: string
          nullable: true
          maxLength: 255
        underwriter_country:
          type: string
          nullable: true
          maxLength: 255
        underwriter_name:
          type: string
          nullable: true
          maxLength: 255
        underwriter_state:
          type: string
          nullable: true
          maxLength: 255
        underwriter_street:
          type: string
          nullable: true
          maxLength: 255
        underwriter_street2:
          type: string
          nullable: true
          maxLength: 255
        underwriter_zip:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_assistant_name:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_city:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_contact_name:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_country:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_email:
          type: string
          format: email
          nullable: true
          maxLength: 255
        wholesale_broker_name:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_state:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_street:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_street2:
          type: string
          nullable: true
          maxLength: 255
        wholesale_broker_zip:
          type: string
          nullable: true
          maxLength: 255
      required:
        - broker_full_address
        - cat_modeling_term_selectors_read_only
        - num_buildings
    ErrorResponse401:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Request ID
        message:
          type: string
          description: Authorization error message.
      required:
        - id
        - message
    ErrorResponse403:
      type: object
      properties:
        detail:
          type: string
          description: Error message.
      required:
        - detail
  securitySchemes:
    authorization_header:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Supports `Token `-prefixed API keys and `Bearer `-prefixed JWT-based
        authentication.

````