Update a feature flag.

Partially update a feature flag by ID. Only provided fields are updated.

PATCH https://{tenantDomain}/api/v2/experimentation/feature-flags/{id}

Update a feature flag.

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/experimentation/feature-flags/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "parameters": {}
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "parameters": {}
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

The ID of the feature flag to update.

Corps

application/jsonapplication/x-www-form-urlencoded

Partial update of a feature flag. Only provided fields are updated.

name · string

A human-readable name for the feature flag

Required string length: 3 - 255

Pattern: ^(?!.*\x00)\S(.*\S)?$

description · string | null

A description of what this feature flag controls

Required string length: 3 - 1024

Pattern: ^(?!.*\x00)\S(.*\S)?$

parameters · object

Configuration parameters for this feature flag

Show child attributes

Réponse

200

application/json

Feature flag successfully updated.

id · string · requis

Pattern: ^flg_[A-HJ-NP-Za-km-z1-9]+$

name · string · requis

type · enum<string> · requis

Filter by type. Exact match.

Options disponibles: auth0, self

status · enum<string> · requis

Filter by status. Exact match.

Options disponibles: draft, active, archived

created_at · string<date-time> · requis

updated_at · string<date-time> · requis

description · string

parameters · object

Configuration parameters for this feature flag

Show child attributes