Update a product version

Updates the specified product version by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/product-versions/{id}
JWT
productVersion:write

Parameters

NameTypeInDescription
id*stringpathUnique identifier for the product version.

Request Body Schema

PropertyTypeDescriptionConstraints
namestringName of the product version.min: 1, max: 256
displayNamestringDisplay name of the product version, shown in the customer portal.min: 1, max: 256
descriptionstringDescription for the product version.min: 1, max: 256
featureFlagsarrayList of feature flags.items: object
name*stringName of the feature.min: 1, max: 256
enabled*booleanWhether the feature is enabled.
datastringOptional data associated with the feature flag.min: 0, max: 4096

Request Example

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "featureFlags": [
    {
      "name": "string",
      "enabled": true,
      "data": "string"
    }
  ]
}
Triggers webhook: productVersion.updated
POST <your-webhook-url>
{
  "event": "productVersion.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "productId": "string",
    "featureFlags": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "enabled": true,
        "data": "string"
      }
    ]
  },
  "triggeredAt": "string"
}

Responses

200 OK
{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "displayName": "string",
  "description": "string",
  "productId": "string",
  "featureFlags": [
    {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "enabled": true,
      "data": "string"
    }
  ]
}