Update expiring context targets on feature flag

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instructions": [
    {
      "kind": "addExpireUserTargetDate",
      "userKey": "sandy",
      "value": 1686412800000,
      "variationId": "ce12d345-a1b2-4fb5-a123-ab123d4d5f5d"
    }
  ],
  "comment": "optional comment"
}
'

import requests

url = "https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}"

payload = {
    "instructions": [
        {
            "kind": "addExpireUserTargetDate",
            "userKey": "sandy",
            "value": 1686412800000,
            "variationId": "ce12d345-a1b2-4fb5-a123-ab123d4d5f5d"
        }
    ],
    "comment": "optional comment"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    instructions: [
      {
        kind: 'addExpireUserTargetDate',
        userKey: 'sandy',
        value: 1686412800000,
        variationId: 'ce12d345-a1b2-4fb5-a123-ab123d4d5f5d'
      }
    ],
    comment: 'optional comment'
  })
};

fetch('https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'instructions' => [
        [
                'kind' => 'addExpireUserTargetDate',
                'userKey' => 'sandy',
                'value' => 1686412800000,
                'variationId' => 'ce12d345-a1b2-4fb5-a123-ab123d4d5f5d'
        ]
    ],
    'comment' => 'optional comment'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}"

	payload := strings.NewReader("{\n  \"instructions\": [\n    {\n      \"kind\": \"addExpireUserTargetDate\",\n      \"userKey\": \"sandy\",\n      \"value\": 1686412800000,\n      \"variationId\": \"ce12d345-a1b2-4fb5-a123-ab123d4d5f5d\"\n    }\n  ],\n  \"comment\": \"optional comment\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"instructions\": [\n    {\n      \"kind\": \"addExpireUserTargetDate\",\n      \"userKey\": \"sandy\",\n      \"value\": 1686412800000,\n      \"variationId\": \"ce12d345-a1b2-4fb5-a123-ab123d4d5f5d\"\n    }\n  ],\n  \"comment\": \"optional comment\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instructions\": [\n    {\n      \"kind\": \"addExpireUserTargetDate\",\n      \"userKey\": \"sandy\",\n      \"value\": 1686412800000,\n      \"variationId\": \"ce12d345-a1b2-4fb5-a123-ab123d4d5f5d\"\n    }\n  ],\n  \"comment\": \"optional comment\"\n}"

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "_id": "12ab3c45de678910abc12345",
      "_version": 1,
      "expirationDate": "1672358400000",
      "contextKind": "user",
      "contextKey": "context-key-123abc",
      "_resourceId": {
        "environmentKey": "environment-key-123abc",
        "flagKey": "<string>",
        "key": "segment-key-123abc",
        "kind": "segment",
        "projectKey": "project-key-123abc"
      },
      "targetType": "included",
      "variationId": "cc4332e2-bd4d-4fe0-b509-dfd2caf8dd73"
    }
  ],
  "_links": {},
  "totalInstructions": 123,
  "successfulInstructions": 123,
  "failedInstructions": 123,
  "errors": [
    {
      "instructionIndex": 1,
      "message": "example error message"
    }
  ]
}

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

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Update expiring context targets on feature flag

Schedule a context for removal from individual targeting on a feature flag. The flag must already individually target the context.

You can add, update, or remove a scheduled removal date. You can only schedule a context for removal on a single variation per flag.

Updating an expiring target uses the semantic patch format. To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.

Instructions

Semantic patch requests support the following kind instructions for updating expiring targets.

Click to expand instructions for updating expiring targets

addExpiringTarget

Adds a date and time that LaunchDarkly will remove the context from the flag’s individual targeting.

Parameters

value: The time, in Unix milliseconds, when LaunchDarkly should remove the context from individual targeting for this flag
variationId: ID of a variation on the flag
contextKey: The context key for the context to remove from individual targeting
contextKind: The kind of context represented by the contextKey

Here’s an example:

{
  "instructions": [{
    "kind": "addExpiringTarget",
    "value": 1754006460000,
    "variationId": "4254742c-71ae-411f-a992-43b18a51afe0",
    "contextKey": "user-key-123abc",
    "contextKind": "user"
  }]
}

updateExpiringTarget

Updates the date and time that LaunchDarkly will remove the context from the flag’s individual targeting

Parameters

value: The time, in Unix milliseconds, when LaunchDarkly should remove the context from individual targeting for this flag
variationId: ID of a variation on the flag
contextKey: The context key for the context to remove from individual targeting
contextKind: The kind of context represented by the contextKey
version: (Optional) The version of the expiring target to update. If included, update will fail if version doesn’t match current version of the expiring target.

Here’s an example:

{
  "instructions": [{
    "kind": "updateExpiringTarget",
    "value": 1754006460000,
    "variationId": "4254742c-71ae-411f-a992-43b18a51afe0",
    "contextKey": "user-key-123abc",
    "contextKind": "user"
  }]
}

removeExpiringTarget

Removes the scheduled removal of the context from the flag’s individual targeting. The context will remain part of the flag’s individual targeting until you explicitly remove it, or until you schedule another removal.

Parameters

variationId: ID of a variation on the flag
contextKey: The context key for the context to remove from individual targeting
contextKind: The kind of context represented by the contextKey

Here’s an example:

{
  "instructions": [{
    "kind": "removeExpiringTarget",
    "variationId": "4254742c-71ae-411f-a992-43b18a51afe0",
    "contextKey": "user-key-123abc",
    "contextKind": "user"
  }]
}

PATCH

api

flags

{projectKey}

{featureFlagKey}

expiring-targets

{environmentKey}

Update expiring context targets on feature flag

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instructions": [
    {
      "kind": "addExpireUserTargetDate",
      "userKey": "sandy",
      "value": 1686412800000,
      "variationId": "ce12d345-a1b2-4fb5-a123-ab123d4d5f5d"
    }
  ],
  "comment": "optional comment"
}
'

import requests

url = "https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}"

payload = {
    "instructions": [
        {
            "kind": "addExpireUserTargetDate",
            "userKey": "sandy",
            "value": 1686412800000,
            "variationId": "ce12d345-a1b2-4fb5-a123-ab123d4d5f5d"
        }
    ],
    "comment": "optional comment"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    instructions: [
      {
        kind: 'addExpireUserTargetDate',
        userKey: 'sandy',
        value: 1686412800000,
        variationId: 'ce12d345-a1b2-4fb5-a123-ab123d4d5f5d'
      }
    ],
    comment: 'optional comment'
  })
};

fetch('https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'instructions' => [
        [
                'kind' => 'addExpireUserTargetDate',
                'userKey' => 'sandy',
                'value' => 1686412800000,
                'variationId' => 'ce12d345-a1b2-4fb5-a123-ab123d4d5f5d'
        ]
    ],
    'comment' => 'optional comment'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}"

	payload := strings.NewReader("{\n  \"instructions\": [\n    {\n      \"kind\": \"addExpireUserTargetDate\",\n      \"userKey\": \"sandy\",\n      \"value\": 1686412800000,\n      \"variationId\": \"ce12d345-a1b2-4fb5-a123-ab123d4d5f5d\"\n    }\n  ],\n  \"comment\": \"optional comment\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"instructions\": [\n    {\n      \"kind\": \"addExpireUserTargetDate\",\n      \"userKey\": \"sandy\",\n      \"value\": 1686412800000,\n      \"variationId\": \"ce12d345-a1b2-4fb5-a123-ab123d4d5f5d\"\n    }\n  ],\n  \"comment\": \"optional comment\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-targets/{environmentKey}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instructions\": [\n    {\n      \"kind\": \"addExpireUserTargetDate\",\n      \"userKey\": \"sandy\",\n      \"value\": 1686412800000,\n      \"variationId\": \"ce12d345-a1b2-4fb5-a123-ab123d4d5f5d\"\n    }\n  ],\n  \"comment\": \"optional comment\"\n}"

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "_id": "12ab3c45de678910abc12345",
      "_version": 1,
      "expirationDate": "1672358400000",
      "contextKind": "user",
      "contextKey": "context-key-123abc",
      "_resourceId": {
        "environmentKey": "environment-key-123abc",
        "flagKey": "<string>",
        "key": "segment-key-123abc",
        "kind": "segment",
        "projectKey": "project-key-123abc"
      },
      "targetType": "included",
      "variationId": "cc4332e2-bd4d-4fe0-b509-dfd2caf8dd73"
    }
  ],
  "_links": {},
  "totalInstructions": 123,
  "successfulInstructions": 123,
  "failedInstructions": 123,
  "errors": [
    {
      "instructionIndex": 1,
      "message": "example error message"
    }
  ]
}

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

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Authorizations

Authorization

string

header

required

Path Parameters

projectKey

string<string>

required

The project key

environmentKey

string<string>

required

The environment key

featureFlagKey

string<string>

required

The feature flag key

Body

application/json

instructions

object[]

required

The instructions to perform when updating

Show child attributes

Example:

[
  {
    "kind": "addExpireUserTargetDate",
    "userKey": "sandy",
    "value": 1686412800000,
    "variationId": "ce12d345-a1b2-4fb5-a123-ab123d4d5f5d"
  }
]

comment

string

Optional comment describing the change

Example:

"optional comment"

Response

Expiring target response

items

object[]

required

A list of the results from each instruction

Show child attributes

_links

object

The location and content type of related resources

Show child attributes

totalInstructions

integer

successfulInstructions

integer

failedInstructions

integer

errors

object[]

Show child attributes