[BETA] Create a context field | Unleash Documentation

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Endpoint that allows creation of [custom context fields](https://docs.getunleash.io/concepts/unleash-context#custom-context-fields)

[BETA] This API is in beta state, which means it may change or be removed in the future.

Endpoint that allows creation of custom context fields

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Path parameters

projectIdstringRequired

Request

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)

Response headers

locationstring

The location of the newly created resource.

Response

The resource was successfully created.

namestring

The name of the context field

descriptionstring or null

The description of the context field.

stickinessboolean

Does this context field support being used for stickiness calculations

sortOrderinteger

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

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

projectstring

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

[BETA] This API is in beta state, which means it may change or be removed in the future.

Endpoint that allows creation of custom context fields

API key needed to access this API

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

createContextFieldSchema

The name of the context field.

A description of the context field

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

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

A list of allowed values for this context field

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

The location of the newly created resource.

The resource was successfully created.

The name of the context field

The description of the context field.

Does this context field support being used for stickiness calculations

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

When this context field was created

Number of projects where this context field is used in

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

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

$	curl -X POST https://app.unleash-instance.example.com/api/admin/projects/projectId/context \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "subscriptionTier"
>	}'

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	}

$	curl -X POST https://app.unleash-instance.example.com/api/admin/projects/projectId/context \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "subscriptionTier"
>	}'

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	}