v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Flag links (beta)

Update flag link

Update a flag link. Updating a flag link uses a JSON patch representation of the desired changes. To learn more, read Updates.

patch/api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id}

Path parameters

projectKeystring string required

The project key

featureFlagKeystring string required

The feature flag key

idstring string required

The flag link ID

Request body

opstring required

The type of operation to perform

pathstring required

A JSON Pointer string specifying the part of the document to operate on

valuestring

A JSON value used in "add", "replace", and "test" operations

Example request

[
  {
    "op": "replace",
    "path": "/exampleField",
    "value": "new example value"
  }
]

Response

Flag link response

_linksobject required

The location and content type of related resources

_keystring

The flag link key

_integrationKeystring

The integration key for an integration whose <code>manifest.json</code> includes the <code>flagLink</code> capability, if this is a flag link for an existing integration

_idstring required

The ID of this flag link

_deepLinkstring required

The URL for the external resource the flag is linked to

titlestring

The title of the flag link

descriptionstring

The description of the flag link

_metadataobject

The metadata required by this integration in order to create a flag link, if this is a flag link for an existing integration. Defined in the integration's <code>manifest.json</code> file under <code>flagLink</code>.

_createdAtinteger required

Example response

{
  "_key": "flag-link-key-123abc",
  "_id": "1234a56b7c89d012345e678f",
  "_deepLink": "https://example.com/archives/123123123",
  "title": "Example link title",
  "description": "Example link description"
}