Skip to main content

Update an existing context field

PUT 
/api/admin/context/:contextField

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

Request​

Path Parameters

    contextField stringrequired

Body

required

updateContextFieldSchema

    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

  • ]

Responses​

This response has no body.

Loading...