features

Update a feature

Changed on

This endpoint updates an existing feature representing an entitlement component of your application. Only the fields present in the payload are updated. Privileges are matched by their code, an unknown code adds a new privilege and a known one updates its name and adds the select options of the payload to the existing ones. The value type of an existing privilege cannot be changed. Privileges left out of the payload are kept, use the delete privilege endpoint to remove one.

put/features/{code}

Request

Request body

Example request

{
  "feature": {
    "name": "Number of seats",
    "description": "Number of users of the account",
    "privileges": [
      {
        "code": "max",
        "name": "Maximum",
        "value_type": "integer"
      },
      {
        "code": "max_admins",
        "name": "Max Admins",
        "value_type": "integer"
      },
      {
        "code": "root",
        "name": "Allow root user",
        "value_type": "boolean"
      },
      {
        "code": "provider",
        "name": "SSO Provider",
        "value_type": "select",
        "config": {
          "select_options": [
            "google",
            "okta"
          ]
        }
      }
    ]
  }
}

Response

Feature updated

Example response

{
  "feature": {
    "code": "seats",
    "name": "Number of seats",
    "description": "Number of users of the account",
    "privileges": [
      {
        "code": "max",
        "name": "Maximum",
        "value_type": "integer",
        "config": {}
      },
      {
        "code": "max_admins",
        "name": "Max Admins",
        "value_type": "integer",
        "config": {}
      },
      {
        "code": "root",
        "name": "Allow root user",
        "value_type": "boolean",
        "config": {}
      },
      {
        "code": "provider",
        "name": "SSO Provider",
        "value_type": "select",
        "config": {
          "select_options": [
            "google",
            "okta"
          ]
        }
      }
    ],
    "created_at": "2025-07-17T12:34:35Z"
  }
}

Changes

    • warning

      the / request property's maxLength was set to 600

    • warning

      the / request property's maxLength was set to 255

    • warning

      the /// request property's maxLength was set to 255

    • warning

      the /// request property's maxLength was set to 255