A valid request URL is required to generate request examples{
"flag": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"enabled": true,
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rollout_percentage": 123,
"archived_at": "2023-11-07T05:31:56Z",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"propagation": {
"seconds": 123,
"note": "<string>"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Update a feature flag
Requires flags:manage. Partial: an omitted field keeps its value.
segment_id and rollout_percentage are the two where omitted and null differ. Omitting leaves the current target or ramp alone; sending null clears it — widening the flag to everybody, or removing the ramp. Without that distinction the only way to widen a rollout back out would be deleting and recreating the flag, which re-salts the bucket and reshuffles who is inside.
A flag cannot move between environments, so a new segment_id is validated against the one it already lives in. archived: false puts an archived flag back into circulation.
Flipping enabled is the kill switch. See propagation for how long it takes to reach a page.
A valid request URL is required to generate request examples{
"flag": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"enabled": true,
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rollout_percentage": 123,
"archived_at": "2023-11-07T05:31:56Z",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"propagation": {
"seconds": 123,
"note": "<string>"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Path Parameters
Body
80null clears the target — the flag applies to everybody.
null removes the ramp entirely, which is not the same as 0.
0 <= x <= 100true archives, false restores.
Response
The flag as it now stands.
A release switch, aimed at a segment and never at a filter of its own. The bucketing salt is deliberately not part of this: it is the one value that would let somebody compute which bucket they are in and pick an identifier that lands inside a ramp.
Show child attributes
Show child attributes
How long a flip takes to reach a page, reported by the API rather than assumed by a screen — it is the sum of three things this API decides, and a screen that hard-coded it would go on claiming the old number.
Show child attributes
Show child attributes