On this page
No Headings
Request payload for updating an existing feature. All fields are optional - only provided fields will be updated. Note that the feature code cannot be changed.
objectnamestringName of the feature
descriptionstringDescription of the feature
privilegesarrayUpdated list of privileges for the feature. This replaces the entire privileges array - to add or remove individual privileges, include the complete desired list.
itemsobjectDefines a configurable aspect of a feature that can be assigned different values when entitled to plans or subscriptions
coderequiredstring^[a-zA-Z0-9_-]+$Unique identifier for the privilege within its parent feature. Used as a key when assigning values to this privilege in entitlements. Allows alphanumeric characters, underscores, and hyphens.
namestringHuman-friendly display name for the privilege shown in user interfaces. This helps users understand what aspect of the feature is being configured.
value_typestring"STRING", "BOOLEAN", "INTEGER", "SELECT""STRING"Defines the data type that this privilege accepts when being assigned values in entitlements. 'INTEGER' for numeric limits, 'BOOLEAN' for on/off toggles, 'STRING' for text values, 'SELECT' for predefined options.
configobjectAdditional configuration for privileges that require constraints or options. Currently used for 'select' type privileges to define allowed values.
select_optionsarrayDefines the allowed values when value_type is 'select'. When creating entitlements, only these predefined options can be assigned. Useful for features like SSO providers, regions, or service tiers.
itemsstring