Flag links (beta)

Create flag link

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

Create a new flag link. Flag links let you reference external resources and associate them with your flags.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

projectKey*string

The project key

Formatstring
featureFlagKey*string

The feature flag key

Formatstring

Request Body

application/json

key?string

The flag link key

integrationKey?string

The integration key for an integration whose manifest.json includes the flagLink capability, if this is a flag link for an existing integration. Do not include for URL flag links.

timestamp?UnixMillis

The time, in Unix milliseconds, to mark this flag link as associated with the external URL. If omitted, defaults to the creation time of this flag link.

Formatint64
deepLink?string

The URL for the external resource you are linking the flag to

title?string

The title of the flag link

description?string

The description of the flag link

metadata?

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 manifest.json file under flagLink.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v2/flag-links/projects/string/flags/string" \  -H "Content-Type: application/json" \  -d '{    "deepLink": "https://example.com/archives/123123123",    "description": "Example link description",    "key": "flag-link-key-123abc",    "title": "Example link title"  }'
{  "_links": {    "property1": {      "href": "string",      "type": "string"    },    "property2": {      "href": "string",      "type": "string"    }  },  "_key": "flag-link-key-123abc",  "_integrationKey": "string",  "_id": "1234a56b7c89d012345e678f",  "_deepLink": "https://example.com/archives/123123123",  "_timestamp": "{\"milliseconds\": 1655342199935, \"seconds\": 1655342199, \"rfc3339\": \"2022-06-16T01:16:39Z\", \"simple\": \"2022-06-16 01:16:39\"}",  "title": "Example link title",  "description": "Example link description",  "_metadata": {    "property1": "string",    "property2": "string"  },  "_createdAt": "1654104600000",  "_member": {    "_links": {      "property1": {        "href": "string",        "type": "string"      },      "property2": {        "href": "string",        "type": "string"      }    },    "_id": "string",    "firstName": "string",    "lastName": "string"  }}