Create a context field | Unleash Documentation

This is a beta endpoint and it may change or be removed in the future.

Endpoint that allows creation of custom context fields

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

projectIdstringRequired

createContextFieldSchema

namestringRequired

The name of the context field.

descriptionstringOptional

A description of the context field

stickinessbooleanOptional

true if this field should be available for use with custom stickiness, otherwise false

sortOrderintegerOptional

How this context field should be sorted if no other sort order is selected

legalValueslist of objectsOptional

A list of allowed values for this context field

projectstringOptional

The project this context field belongs to (if it is project-specific)

locationstring or null

The location of the newly created resource.

The resource was successfully created.

namestring

The name of the context field

descriptionstring or null

The description of the context field.

stickinessboolean or null

Does this context field support being used for stickiness calculations

sortOrderinteger or null

Used when sorting a list of context fields. Is also used as a tiebreaker if a list of context fields is sorted alphabetically.

createdAtstring or nullformat: "date-time"

When this context field was created

usedInFeaturesinteger or null>=0

Number of projects where this context field is used in

usedInProjectsinteger or null>=0

Number of projects where this context field is used in

legalValueslist of objects or null

Allowed values for this context field schema. Can be used to narrow down accepted input

projectstring or null

The project this context field belongs to (if it is project-specific)

1	import requests
2
3	url = "https://app.unleash-instance.example.com/api/admin/projects/projectId/context"
4
5	payload = { "name": "subscriptionTier" }
6	headers = {
7	"Authorization": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"name": "userId",
3	"description": "Used to uniquely identify users",
4	"stickiness": true,
5	"sortOrder": 900,
6	"createdAt": "2023-06-29T10:19:00.000Z",
7	"usedInFeatures": 3,
8	"usedInProjects": 2,
9	"legalValues": [
10	{
11	"value": "#c154c1",
12	"description": "Deep fuchsia"
13	}
14	],
15	"project": "my-project"
16	}