Context

Update an existing context field

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

put/api/admin/context/{contextField}

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/context/{contextField}
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

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.

Changes

No recorded changes to this operation across all 7 revisions of this API.