v5

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

Feature flags

Update expiring user targets on feature flag

Contexts are now available

After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use Update expiring context targets on feature flag instead of this endpoint. To learn more, read Contexts.

Schedule a target for removal from individual targeting on a feature flag. The flag must already serve a variation to specific targets based on their key.

You can add, update, or remove a scheduled removal date. You can only schedule a target 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 user targets.

<details> <summary>Click to expand instructions for <strong>updating expiring user targets</strong></summary>

addExpireUserTargetDate

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

Parameters

value: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag
variationId: ID of a variation on the flag
userKey: The user key for the user to remove from individual targeting

updateExpireUserTargetDate

Updates the date and time that LaunchDarkly will remove the user from the flag's individual targeting.

Parameters

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

removeExpireUserTargetDate

Removes the scheduled removal of the user from the flag's individual targeting. The user will remain part of the flag's individual targeting until you explicitly remove them, or until you schedule another removal.

Parameters

variationId: ID of a variation on the flag
userKey: The user key for the user to remove from individual targeting

</details>

patch/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}

Path parameters

projectKeystring string required

The project key

environmentKeystring string required

The environment key

featureFlagKeystring string required

The feature flag key

Request body

commentstring

Optional comment describing the change

instructionsInstruction[] required

The instructions to perform when updating

Example request

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

Response

Expiring user target response

_linksobject

The location and content type of related resources

totalInstructionsinteger

The total count of instructions sent in the PATCH request

successfulInstructionsinteger

The total count of successful instructions sent in the PATCH request

failedInstructionsinteger

The total count of the failed instructions sent in the PATCH request

Example response

{
  "items": [
    {
      "_id": "12ab3c45de678910fgh12345",
      "_version": 1,
      "userKey": "example-user-key",
      "targetType": "included",
      "variationId": "ce67d625-a8b9-4fb5-a344-ab909d9d4f4d"
    }
  ],
  "totalInstructions": 1,
  "successfulInstructions": 1,
  "errors": [
    {
      "instructionIndex": 1,
      "message": "example error message"
    }
  ]
}