Skip to main content

Update segment by id

PUT 

/api/admin/segments/:id

Updates the content of the segment with the provided payload. Requires name and constraints to be present. If project is not present, it will be set to null. Any other fields not specified will be left untouched.

Request

Path Parameters

    id stringrequired

Body

required

upsertSegmentSchema

    name stringrequired

    The name of the segment

    Example: beta-users
    description stringnullable

    A description of what the segment is for

    Example: Users willing to help us test and build new features.
    project stringnullable

    The project the segment belongs to if any.

    Example: red-vista

    constraints

    object[]

    required

    The list of constraints that make up this segment

  • Array [

  • contextName stringrequired

    The name of the context field that this constraint should apply to.

    Example: appName
    operator stringrequired

    The operator to use when evaluating this constraint. For more information about the various operators, refer to the strategy constraint operator documentation.

    Possible values: [NOT_IN, IN, STR_ENDS_WITH, STR_STARTS_WITH, STR_CONTAINS, NUM_EQ, NUM_GT, NUM_GTE, NUM_LT, NUM_LTE, DATE_AFTER, DATE_BEFORE, SEMVER_EQ, SEMVER_GT, SEMVER_LT]

    Example: IN
    caseInsensitive boolean

    Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

    Default value: false
    inverted boolean

    Whether the result should be negated or not. If true, will turn a true result into a false result and vice versa.

    Default value: false
    values string[]

    The context values that should be used for constraint evaluation. Use this property instead of value for properties that accept multiple values.

    Example: ["my-app","my-other-app"]
    value string

    The context value that should be used for constraint evaluation. Use this property instead of values for properties that only accept single values.

    Example: my-app
  • ]

Responses

This response has no body.

Loading...