OverviewFeature 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.

Click to expand instructions for updating expiring user targets

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

Path parameters

projectKeystringRequired
The project key
environmentKeystringRequired
The environment key
featureFlagKeystringRequired
The feature flag key

Headers

AuthorizationstringRequired

Request

This endpoint expects an object.
instructionslist of maps from strings to anyRequired
The instructions to perform when updating
commentstringOptional
Optional comment describing the change

Response

Expiring user target response
itemslist of objects
An array of expiring user targets
totalInstructionsinteger or null
The total count of instructions sent in the PATCH request
successfulInstructionsinteger or null
The total count of successful instructions sent in the PATCH request
failedInstructionsinteger or null
The total count of the failed instructions sent in the PATCH request
errorslist of objects or null
An array of error messages for the failed instructions

Errors