---
title: "Update API Product Version Request"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-products-2/versions/eaf2cded-a760-4559-80d6-16254036c550/schemas/UpdateAPIProductVersionDTO"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-products-2/versions/eaf2cded-a760-4559-80d6-16254036c550.md

# Update API Product Version Request

The request schema for updating a version of an API product. Note that the `publish_status` and `deprecated` fields are deprecated: Use [PortalProductVersion.publish_status](https://docs.konghq.com/konnect/api/portal-management/v2/#/operations/create-portal-product-version) instead.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect API Products
  version: 2.0.0
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
components:
  schemas:
    GatewayServicePayload:
      type: object
      properties:
        id:
          description: The identifier of a gateway service associated with the version of
            the API product.
          type: string
          format: uuid
          example: 09b4786a-3e48-4631-8f6b-62d1d8e1a7f3
        control_plane_id:
          description: The identifier of the control plane that the gateway service
            resides in
          type: string
          format: uuid
          example: e4d9ebb1-26b4-426a-b00e-cb67044f3baf
      additionalProperties: false
      nullable: true
      required:
        - id
        - control_plane_id
    LegacyGatewayServicePayload:
      type: object
      properties:
        id:
          description: The identifier of a gateway service associated with the version of
            the API product.
          type: string
          format: uuid
          example: 09b4786a-3e48-4631-8f6b-62d1d8e1a7f3
        runtime_group_id:
          description: The identifier of the control plane that the gateway service
            resides in
          type: string
          format: uuid
          example: e4d9ebb1-26b4-426a-b00e-cb67044f3baf
          deprecated: true
      additionalProperties: false
      nullable: true
      required:
        - id
        - runtime_group_id
    LabelsUpdate:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Labels are intended to store **INTERNAL** metadata.


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
        nullable: true
      maxProperties: 50
      nullable: true
      writeOnly: true
    UpdateAPIProductVersionDTO:
      description: |
        The request schema for updating a version of an API product.
        Note that the `publish_status` and `deprecated` fields are deprecated:  Use [PortalProductVersion.publish_status](https://docs.konghq.com/konnect/api/portal-management/v2/#/operations/create-portal-product-version) instead.
      type: object
      properties:
        name:
          description: The version name of the API product version.
          type: string
          example: v1
          minLength: 1
        publish_status:
          description: "The publish status of the API product version. Applies publish
            status to all related portal product versions. This field is
            deprecated: Use
            [PortalProductVersion.publish_status](https://docs.konghq.com/konne\
            ct/api/portal-management/v2/#/operations/create-portal-product-vers\
            ion) instead."
          type: string
          example: unpublished
          enum:
            - unpublished
            - published
          deprecated: true
        deprecated:
          description: "Indicates if the version of the API product is deprecated. Applies
            deprecation or removes deprecation from all related portal product
            versions. This field is deprecated: Use
            [PortalProductVersion.deprecated](https://docs.konghq.com/konnect/a\
            pi/portal-management/v2/#/operations/create-portal-product-version)
            instead."
          type: boolean
          example: false
          deprecated: true
        notify:
          description: >
            When set to `true`, and all the following conditions are true:

            - version of the API product deprecation has changed from `false` ->
            `true`

            - version of the API product is published


            then consumers of the now deprecated verion of the API product will
            be notified.
          type: boolean
          example: true
          nullable: false
        gateway_service:
          anyOf:
            - $ref: "#/components/schemas/GatewayServicePayload"
            - $ref: "#/components/schemas/LegacyGatewayServicePayload"
        labels:
          $ref: "#/components/schemas/LabelsUpdate"
      additionalProperties: false
      title: Update API Product Version Request
```
