Skip to content

Updates an existing feature of a product; only the fields set on the body are changed.

PATCH
/api/v1/provision/admin/products/{productId}/features/{featureId}
curl --request PATCH \
--url https://example.com/api/v1/provision/admin/products/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/features/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Content-Type: application/json' \
--data '{ "moduleName": "example", "name": "example", "description": "example", "value": "example", "version": "example", "isEnabled": true, "includeInLicenseToken": true, "isAvailableDuringTrialPeriod": true, "isAvailableDuringGracePeriod": true, "isPaidFeature": true, "canModifyValueOnEntitlement": true, "featurePath": "example", "featureCatalogId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "featureCode": "example", "meterAggregationType": "CumulativeCounter", "sortOrder": 1 }'
productId
required
string format: uuid

The unique identifier of the product.

featureId
required
string format: uuid

The unique identifier of the feature to update.

Patch payload — unset/null properties are left unchanged.

Admin update payload for a product feature; null properties leave the existing value unchanged. Use ProductFeatureUpdateDto ProductFeatureUpdateDto.FromProductFeature(ProductFeatureDto feature) to prefill from a current ProductFeatureDto.

object
moduleName
null | string
name
null | string
description
null | string
value
null | string
version
null | string
isEnabled
null | boolean
includeInLicenseToken
null | boolean
isAvailableDuringTrialPeriod
null | boolean
isAvailableDuringGracePeriod
null | boolean
isPaidFeature
null | boolean
canModifyValueOnEntitlement
null | boolean
featurePath
null | string
featureCatalogId
null | string format: uuid
featureCode
null | string
meterAggregationType
One of:
null
sortOrder

Where the feature appears among the product’s features.

null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/

Returns the updated feature details.

A feature as defined on a product: default value, enablement, trial/grace availability, license-token inclusion, and metering configuration. Entitlements inherit these defaults.

object
id
string format: uuid
featureCatalogId
null | string format: uuid
featureCode
string
featurePath
null | string
moduleName
null | string
name
string
description
null | string
usageMetric
null | string
units
null | string
featureType

Data type of a feature’s value; determines how Value strings are interpreted and enforced.

Allowed values: Boolean Numeric Text Enumeration Metered JsonField
enumOptions
Array<object>

One allowed value of an Enumeration-typed feature.

object
value
string
description
null | string
value
null | string
version
null | string
isEnabled
boolean
includeInLicenseToken
boolean
isAvailableDuringTrialPeriod
boolean
isAvailableDuringGracePeriod
boolean
isPaidFeature

When true, the feature is withheld for the duration of a trial even if enabled.

boolean
canModifyValueOnEntitlement
boolean
meterAggregationType
One of:
null
visibility

Who can see a feature.

Allowed values: Public Internal
sortOrder

Where the feature appears among the product’s features. The vendor sets it; every list of a product’s features is ordered by it, so the screens agree with each other.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
isDeleted
boolean
creationTimeStamp
string format: date-time
lastUpdateTimeStamp
null | string format: date-time
revisionNumber
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/