Update flag settings for context

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Enable or disable a feature flag for a context based on its context kind and key.

In the request body, the setting should be the variation value to set for the context. It must match the flag’s variation type. For example, for a boolean flag you can use "setting": true or "setting": false in the request body. For a string flag, you can use "setting": "existing_variation_value_to_use".

Omitting the setting attribute from the request body, or including a setting of null, erases the current setting for a context.

If you previously patched the flag, and the patch included the context’s data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the combination of the context’s key and kind before, it calculates the flag values based on the context kind and key.

PUT /api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/{contextKind}/{contextKey}/flags/{featureFlagKey}

Update flag settings for context

cURL

curl --request PUT \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/environments/{environmentKey}/contexts/{contextKind}/{contextKey}/flags/{featureFlagKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "setting": "existing_variation_value_to_use",
  "comment": "make sure this context experiences a specific variation"
}
'

400

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

environmentKey · string<string> · required

The environment key

contextKind · string<string> · required

The context kind

contextKey · string<string> · required

The context key

featureFlagKey · string<string> · required

The feature flag key

Body

application/json

setting · any

The variation value to set for the context. Must match the flag's variation type.

Example:

"existing_variation_value_to_use"

comment · string

Optional comment describing the change

Example:

"make sure this context experiences a specific variation"

Response

204

Action succeeded