v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-013764062.2 MB

Context

[BETA] Create a context field

[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

post/api/admin/projects/{projectId}/context

Path parameters

projectIdstring required

Request body

descriptionstring

A description of the context field

stickinessboolean

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

sortOrderinteger

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

projectstring

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

namestring required

The name of the context field.

Example request

{
  "description": "The user's subscription tier",
  "sortOrder": 2,
  "legalValues": [
    {
      "value": "gold"
    },
    {
      "value": "silver"
    },
    {
      "value": "crystal"
    }
  ],
  "project": "my-project",
  "name": "subscriptionTier"
}

Response

The resource was successfully created.

namestring required

The name of the context field

descriptionstring nullable

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 date-time nullable

When this context field was created

usedInFeaturesinteger nullable

Number of projects where this context field is used in

usedInProjectsinteger nullable

Number of projects where this context field is used in

projectstring

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

Example response

{
  "name": "userId",
  "description": "Used to uniquely identify users",
  "stickiness": true,
  "sortOrder": 900,
  "createdAt": "2023-06-29T10:19:00.000Z",
  "usedInFeatures": 3,
  "usedInProjects": 2,
  "legalValues": [
    {
      "value": "#c154c1",
      "description": "Deep fuchsia"
    }
  ],
  "project": "my-project"
}