Add features to a package

Add features to a package.

post
Path parameters
packageIdstringRequired

The package id.

Header parameters
Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL
Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY
Bodyobject[]

The package feature request to add feature into package.

typestring · enumRequiredPossible values:
featureIdstring · min: 1Required

The feature id.

titlestring | nullableOptional

The title of the feature. This title is used to display the feature in the UI.

valueinteger · int32 | nullableOptional

The quantity of the feature follow by package.

isUnlimitedbooleanOptional

Flag to indicate if the feature is unlimited. Default is false.

resetPolicystring · enumOptional

Defines the available reset policies for quotas. A reset policy determines how often a quota is replenished (e.g., daily, monthly, yearly).

Supported values:

Possible values:
customIntervalDaysinteger · int32 | nullableOptional

Optional number of days to use when Jfw.Api.Models.requests.PackageFeatureRequest.ResetPolicy is set to Jfw.Core.EntityClasses.QuotaResetPolicy.Custom.

Responses
200

The request was successful.

application/json
post
POST /api/v1/packages/{packageId}/features HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 132

[
  {
    "type": "Function",
    "featureId": "text",
    "title": "text",
    "value": 1,
    "isUnlimited": true,
    "resetPolicy": "Lifetime",
    "customIntervalDays": 1
  }
]
{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}

Last updated

Was this helpful?