Create a context field

POST 
/api/admin/context

Endpoint that allows creation of custom context fields

Request

application/json

Body

required

createContextFieldSchema

description string
A description of the context field
Example: The user's subscription tier
stickiness boolean
true if this field should be available for use with custom stickiness, otherwise false
Example: false
sortOrder integer
How this context field should be sorted if no other sort order is selected
Example: 2

legalValues

object[]

A list of allowed values for this context field

Array [

value stringrequired

The valid value

Example: #c154c1

description string

Describes this specific legal value

Example: Deep fuchsia

]

name stringrequired
The name of the context field.
Example: subscriptionTier

Responses

201

The resource was successfully created.

Response Headers

• location

  string

  The location of the newly created resource.

application/json

Schema

Schema

name stringrequired
The name of the context field
Example: userId
description stringnullable
The description of the context field.
Example: Used to uniquely identify users
stickiness boolean
Does this context field support being used for stickiness calculations
Example: true
sortOrder integer
Used when sorting a list of context fields. Is also used as a tiebreaker if a list of context fields is sorted alphabetically.
Example: 900
createdAt date-timenullable
When this context field was created
Example: 2023-06-29T10:19:00.000Z
usedInFeatures integernullable
Number of projects where this context field is used in
Example: 3
usedInProjects integernullable
Number of projects where this context field is used in
Example: 2

legalValues

object[]

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

Array [

value stringrequired

The valid value

Example: #c154c1

description string

Describes this specific legal value

Example: Deep fuchsia

]

Example (from schema)

{
  "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"
    }
  ]
}

Loading...