PATCH /v1/projects/{projectIdOrName}/feature-flags/segments/{segmentIdOrSlug}

Update an existing feature flag segment.

Servers

Path parameters

Name Type Required Description
projectIdOrName String Yes

The project id or name

segmentIdOrSlug String Yes

The segment slug

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
teamId String No

The Team identifier to perform the request on behalf of.

slug String No

The Team slug to perform the request on behalf of.

withMetadata Boolean No

Whether to include metadata

Default value: false

Request body fields

Name Type Required Description
data Object No

The data of the segment

data.rules[] Array No
data.rules[].id String Yes
data.rules[].conditions[] Array Yes
data.rules[].conditions[].rhs No
data.rules[].conditions[].cmp String Yes

Valid values:

  • "containsNoneOf"
  • "gt"
  • "gte"
  • "eq"
  • "!endsWith"
  • "after"
  • "regex"
  • "!regex"
  • "endsWith"
  • "lt"
  • "startsWith"
  • "containsAnyOf"
  • "before"
  • "lte"
  • "!eq"
  • "!oneOf"
  • "containsAllOf"
  • "oneOf"
  • "!startsWith"
  • "ex"
  • "!ex"
data.rules[].conditions[].lhs Yes
data.rules[].outcome Yes
data.include Object No
data.exclude Object No
description String No
label String No
hint String No
operations[] Array No
operations[].field String Yes

Valid values:

  • "include"
  • "exclude"
operations[].action String Yes

Valid values:

  • "remove"
  • "add"
operations[].entity String Yes
operations[].attribute String Yes
operations[].value Object Yes
operations[].value.note String No
operations[].value.value String Yes

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.