Skip to content
Featureflip Docs

Updates a targeting rule's variation/description/rollout/segment/conditions wholesale.

PUT
/api/v1/orgs/{org}/projects/{project}/flags/{flag}/environments/{env}/rules/{ruleId}
curl --request PUT \
  --url https://api.featureflip.io/api/v1/orgs/example/projects/example/flags/example/environments/example/rules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "variationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "rolloutPercentage": 1, "userSegmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "conditionGroups": [ { "operator": "And", "conditions": [ { "attribute": "example", "operator": "Equals", "values": [ "example" ], "negate": true } ] } ] }'

Requires at least Member.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string
project
required
string
flag
required
string
env
required
string
ruleId
required
string format: uuid

Request Body

Section titled “Request Body”

Request body for PUT .../rules/{ruleId}. Same shape as PublicCreateTargetingRuleRequest — see its remarks on operator validation/canonicalization, which applies identically here.

object
description
string
nullable
variationId
string format: uuid
rolloutPercentage
integer format: int32
nullable
userSegmentId
string format: uuid
nullable
conditionGroups
Array<object>
nullable

Request-side condition group, symmetric with PublicConditionGroupResponse.

object
operator

Allowed values: And, Or.

string
nullable
Allowed values: And Or
conditions
Array<object>
nullable

Request-side condition, symmetric with PublicConditionResponse.

object
attribute
string
nullable
operator

Allowed values: Equals, NotEquals, Contains, NotContains, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, In, NotIn, MatchesRegex, StartsWith, EndsWith, Before, After, SemverEquals, SemverGreaterThan, SemverGreaterThanOrEqual, SemverLessThan, SemverLessThanOrEqual.

string
nullable
Allowed values: Equals NotEquals Contains NotContains GreaterThan LessThan GreaterThanOrEqual LessThanOrEqual In NotIn MatchesRegex StartsWith EndsWith Before After SemverEquals SemverGreaterThan SemverGreaterThanOrEqual SemverLessThan SemverLessThanOrEqual
values
Array<string>
nullable
negate
boolean

Responses

Section titled “Responses”

204

Section titled “204”

No Content

Headers

Section titled “Headers”
X-RateLimit-Limit
integer

The maximum number of requests permitted per rate-limit window for this caller.

X-RateLimit-Remaining
integer

The number of requests remaining in the current rate-limit window.

X-RateLimit-Reset
integer

The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.

400

Section titled “400”

Bad Request

Media typeapplication/json

The frozen public-API error contract. error codes are stable snake_case strings. Wire keys are frozen snake_case too (error, message, docs_url, fields, retry_after) — the global camelCase naming policy would otherwise emit docsUrl/retryAfter, breaking the published spec. !:JsonPropertyName always wins over the policy, so these are pinned explicitly rather than relying on the property names already being lowercase for the single-word ones. did_you_mean and next_actions are ADDITIVE optional keys (null → omitted via the global DefaultIgnoreCondition = WhenWritingNull), so pre-existing error bodies are byte-for-byte unchanged when they’re absent.

object
error
string
nullable
message
string
nullable
docs_url
string
nullable
fields
object
key
additional properties
Array<string>
retry_after
integer format: int32
nullable
did_you_mean
Array<string>
nullable
next_actions
Array<object>
nullable
object
method
string
nullable
path
string
nullable
Example
{
  "error": "not_found",
  "message": "Flag 'new-checkout-flw' was not found in project 'checkout'.",
  "docs_url": "https://featureflip.io/docs/management-api/errors/not_found",
  "did_you_mean": [
    "new-checkout-flow"
  ],
  "next_actions": [
    {
      "method": "GET",
      "path": "/api/v1/orgs/acme/projects/checkout/flags"
    }
  ]
}

Headers

Section titled “Headers”
X-RateLimit-Limit
integer

The maximum number of requests permitted per rate-limit window for this caller.

X-RateLimit-Remaining
integer

The number of requests remaining in the current rate-limit window.

X-RateLimit-Reset
integer

The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.

401

Section titled “401”

Authentication is required, or the supplied API token is invalid or expired.

Media typeapplication/json

The frozen public-API error contract. error codes are stable snake_case strings. Wire keys are frozen snake_case too (error, message, docs_url, fields, retry_after) — the global camelCase naming policy would otherwise emit docsUrl/retryAfter, breaking the published spec. !:JsonPropertyName always wins over the policy, so these are pinned explicitly rather than relying on the property names already being lowercase for the single-word ones. did_you_mean and next_actions are ADDITIVE optional keys (null → omitted via the global DefaultIgnoreCondition = WhenWritingNull), so pre-existing error bodies are byte-for-byte unchanged when they’re absent.

object
error
string
nullable
message
string
nullable
docs_url
string
nullable
fields
object
key
additional properties
Array<string>
retry_after
integer format: int32
nullable
did_you_mean
Array<string>
nullable
next_actions
Array<object>
nullable
object
method
string
nullable
path
string
nullable
Example
{
  "error": "not_found",
  "message": "Flag 'new-checkout-flw' was not found in project 'checkout'.",
  "docs_url": "https://featureflip.io/docs/management-api/errors/not_found",
  "did_you_mean": [
    "new-checkout-flow"
  ],
  "next_actions": [
    {
      "method": "GET",
      "path": "/api/v1/orgs/acme/projects/checkout/flags"
    }
  ]
}

Headers

Section titled “Headers”
X-RateLimit-Limit
integer

The maximum number of requests permitted per rate-limit window for this caller.

X-RateLimit-Remaining
integer

The number of requests remaining in the current rate-limit window.

X-RateLimit-Reset
integer

The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.

403

Section titled “403”

Forbidden

Media typeapplication/json

The frozen public-API error contract. error codes are stable snake_case strings. Wire keys are frozen snake_case too (error, message, docs_url, fields, retry_after) — the global camelCase naming policy would otherwise emit docsUrl/retryAfter, breaking the published spec. !:JsonPropertyName always wins over the policy, so these are pinned explicitly rather than relying on the property names already being lowercase for the single-word ones. did_you_mean and next_actions are ADDITIVE optional keys (null → omitted via the global DefaultIgnoreCondition = WhenWritingNull), so pre-existing error bodies are byte-for-byte unchanged when they’re absent.

object
error
string
nullable
message
string
nullable
docs_url
string
nullable
fields
object
key
additional properties
Array<string>
retry_after
integer format: int32
nullable
did_you_mean
Array<string>
nullable
next_actions
Array<object>
nullable
object
method
string
nullable
path
string
nullable
Example
{
  "error": "not_found",
  "message": "Flag 'new-checkout-flw' was not found in project 'checkout'.",
  "docs_url": "https://featureflip.io/docs/management-api/errors/not_found",
  "did_you_mean": [
    "new-checkout-flow"
  ],
  "next_actions": [
    {
      "method": "GET",
      "path": "/api/v1/orgs/acme/projects/checkout/flags"
    }
  ]
}

Headers

Section titled “Headers”
X-RateLimit-Limit
integer

The maximum number of requests permitted per rate-limit window for this caller.

X-RateLimit-Remaining
integer

The number of requests remaining in the current rate-limit window.

X-RateLimit-Reset
integer

The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.

404

Section titled “404”

Not Found

Media typeapplication/json

The frozen public-API error contract. error codes are stable snake_case strings. Wire keys are frozen snake_case too (error, message, docs_url, fields, retry_after) — the global camelCase naming policy would otherwise emit docsUrl/retryAfter, breaking the published spec. !:JsonPropertyName always wins over the policy, so these are pinned explicitly rather than relying on the property names already being lowercase for the single-word ones. did_you_mean and next_actions are ADDITIVE optional keys (null → omitted via the global DefaultIgnoreCondition = WhenWritingNull), so pre-existing error bodies are byte-for-byte unchanged when they’re absent.

object
error
string
nullable
message
string
nullable
docs_url
string
nullable
fields
object
key
additional properties
Array<string>
retry_after
integer format: int32
nullable
did_you_mean
Array<string>
nullable
next_actions
Array<object>
nullable
object
method
string
nullable
path
string
nullable
Example
{
  "error": "not_found",
  "message": "Flag 'new-checkout-flw' was not found in project 'checkout'.",
  "docs_url": "https://featureflip.io/docs/management-api/errors/not_found",
  "did_you_mean": [
    "new-checkout-flow"
  ],
  "next_actions": [
    {
      "method": "GET",
      "path": "/api/v1/orgs/acme/projects/checkout/flags"
    }
  ]
}

Headers

Section titled “Headers”
X-RateLimit-Limit
integer

The maximum number of requests permitted per rate-limit window for this caller.

X-RateLimit-Remaining
integer

The number of requests remaining in the current rate-limit window.

X-RateLimit-Reset
integer

The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.

429

Section titled “429”

Rate limit exceeded. Retry after the interval indicated by the Retry-After header.

Media typeapplication/json

The frozen public-API error contract. error codes are stable snake_case strings. Wire keys are frozen snake_case too (error, message, docs_url, fields, retry_after) — the global camelCase naming policy would otherwise emit docsUrl/retryAfter, breaking the published spec. !:JsonPropertyName always wins over the policy, so these are pinned explicitly rather than relying on the property names already being lowercase for the single-word ones. did_you_mean and next_actions are ADDITIVE optional keys (null → omitted via the global DefaultIgnoreCondition = WhenWritingNull), so pre-existing error bodies are byte-for-byte unchanged when they’re absent.

object
error
string
nullable
message
string
nullable
docs_url
string
nullable
fields
object
key
additional properties
Array<string>
retry_after
integer format: int32
nullable
did_you_mean
Array<string>
nullable
next_actions
Array<object>
nullable
object
method
string
nullable
path
string
nullable
Example
{
  "error": "not_found",
  "message": "Flag 'new-checkout-flw' was not found in project 'checkout'.",
  "docs_url": "https://featureflip.io/docs/management-api/errors/not_found",
  "did_you_mean": [
    "new-checkout-flow"
  ],
  "next_actions": [
    {
      "method": "GET",
      "path": "/api/v1/orgs/acme/projects/checkout/flags"
    }
  ]
}

Headers

Section titled “Headers”
Retry-After
integer

Number of seconds to wait before retrying the request.

X-RateLimit-Limit
integer

The maximum number of requests permitted per rate-limit window for this caller.

X-RateLimit-Remaining
integer

The number of requests remaining in the current rate-limit window.

X-RateLimit-Reset
integer

The UTC time at which the current rate-limit window resets, as a Unix timestamp in seconds.