v7

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

Context

[BETA] Update an existing context field

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

Endpoint that allows updating a custom context field. Used to toggle stickiness and add/remove legal values for this context field

put/api/admin/projects/{projectId}/context/{contextField}

Path parameters

projectIdstring required

contextFieldstring 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)

Example request

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

Response

This response has no body.