Update Segment

Update the segment. Only segments in state UNALLOCATED can be updated.

PATCH /v1/segments/{segment}

Update Segment

cURL

curl --request PATCH \
  --url https://flags.eu.confidence.dev/v1/segments/{segment} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "targeting": {
    "criteria": [
      {}
    ],
    "expression": {}
  },
  "allocation": {},
  "state": {},
  "bitsetAllocation": {},
  "labels": [
    {}
  ],
  "workflowInstance": "<string>",
  "flag": "<string>",
  "owner": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

segment · string · required

Query Parameters

updateMask · object

The list of fields in the Segment that you want to update e.g. 'targeting', if empty all mutable properties are updated. Fields are specified relative to the segment.

Body

application/json

The body is of type object.

Response

200 - application/json

OK

A reusable slice of an entity population.

createTime · object · required

Time when the segment was first created.

updateTime · object · required

Time when the segment was last updated.

creator · string · required

Reference to the identity that created this segment.

updater · string · required

Reference to the identity that last updated this segment.

name · string

The resource name of the segment. For example: segments/0smva5nxuhv4yts6paxt

displayName · string

A human-friendly name for the segment.

description · string

A description for the segment.

targeting · object

The targeting that this segment adheres to.

Show child attributes

allocation · object

How much of the total population that is allocated to this segment, and the coordination with other segments.

state · object

Current state of the segment.

bitsetAllocation · object

A bitset representing the buckets that are allocated for this segment.

labels · object[]

General labels for this resource.

Show child attributes

workflowInstance · string

The workflow instance that created this segment. If set, permissions will be inherited from the workflow instance, in addition to the segment permissions.

flag · string

The flag owning the rule this segment is connected to. If set, permissions will be inherited from the flag, in addition to the segment permissions.

owner · string

The owner of the resource. If not set will default to the creator.