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

# Change Submission Status

> Change the workflow status of a submission.



## OpenAPI

````yaml https://vision.staging.pingintel.com/api/schema/?format=json patch /api/v1/submission/{id}/change_status
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}/change_status:
    patch:
      tags:
        - Update Submission
      summary: Change Submission Status
      description: Change the workflow status of a submission.
      operationId: api_v1_submission_change_status_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/PatchedChangeStatus'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedChangeStatus'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedChangeStatus'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeStatusResponse'
          description: Success response.
        '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:
    PatchedChangeStatus:
      type: object
      properties:
        status_transition_note:
          type: string
          description: Optional note to add when transitioning the submission.
        workflow_status_uuid:
          type: integer
          description: ID of the new workflow status to transition the submission to.
    ChangeStatusResponse:
      type: object
      properties:
        status:
          type: string
          description: Status of the operation.
      required:
        - status
    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.

````