Create (overwrite) variants for a feature in an environment

curl -X PUT https://app.unleash-instance.example.com/api/admin/projects/projectId/features/featureName/environments/environment/variants \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "name": "blue_group",
    "weight": 1.1
  }
]'

{
  "version": 1,
  "variants": [
    {
      "name": "blue_group",
      "weight": 1.1,
      "weightType": "variable",
      "stickiness": "custom.context.field",
      "payload": {
        "type": "json",
        "value": "{\"color\": \"red\"}"
      },
      "overrides": [
        {
          "contextName": "userId",
          "values": [
            "red",
            "blue"
          ]
        }
      ]
    }
  ]
}

This overwrites the current variants for the feature flag in the :featureName parameter for the :environment parameter. The backend will validate the input for the following invariants: * If there are variants, there needs to be at least one variant with `weightType: variable` * The sum of the weights of variants with `weightType: fix` must be strictly less than 1000 (< 1000) The backend will also distribute remaining weight up to 1000 after adding the variants with `weightType: fix` together amongst the variants of `weightType: variable`

curl -X PUT https://app.unleash-instance.example.com/api/admin/projects/projectId/features/featureName/environments/environment/variants \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "name": "blue_group",
    "weight": 1.1
  }
]'

{
  "version": 1,
  "variants": [
    {
      "name": "blue_group",
      "weight": 1.1,
      "weightType": "variable",
      "stickiness": "custom.context.field",
      "payload": {
        "type": "json",
        "value": "{\"color\": \"red\"}"
      },
      "overrides": [
        {
          "contextName": "userId",
          "values": [
            "red",
            "blue"
          ]
        }
      ]
    }
  ]
}

This overwrites the current variants for the feature flag in the :featureName parameter for the :environment parameter.

The backend will validate the input for the following invariants:

If there are variants, there needs to be at least one variant with weightType: variable
The sum of the weights of variants with weightType: fix must be strictly less than 1000 (< 1000)

The backend will also distribute remaining weight up to 1000 after adding the variants with weightType: fix together amongst the variants of weightType: variable

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

projectIdstringRequired

featureNamestringRequired

environmentstringRequired

Request

variantsSchema

namestringRequired

The variants name. Is unique for this feature flag

weightdoubleRequired0-1000

The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on variant weights for more information

weightTypeenumOptional

Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000

Allowed values:

stickinessstringOptional

Stickiness is how Unleash guarantees that the same user gets the same variant every time

payloadobjectOptional

Extra data configured for this variant

overrideslist of objectsOptional

Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.

Response

featureVariantsSchema

versioninteger

The version of the feature variants schema.

variantslist of objects

All variants defined for a specific feature flag.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

$	curl -X PUT https://app.unleash-instance.example.com/api/admin/projects/projectId/features/featureName/environments/environment/variants \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '[
>	{
>	"name": "blue_group",
>	"weight": 1.1
>	}
>	]'

1	{
2	"version": 1,
3	"variants": [
4	{
5	"name": "blue_group",
6	"weight": 1.1,
7	"weightType": "variable",
8	"stickiness": "custom.context.field",
9	"payload": {
10	"type": "json",
11	"value": "{\"color\": \"red\"}"
12	},
13	"overrides": [
14	{
15	"contextName": "userId",
16	"values": [
17	"red",
18	"blue"
19	]
20	}
21	]
22	}
23	]
24	}