Update expiring user target for flags

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Schedule the specified user for removal from individual targeting on one or more flags. The user must already be individually targeted for each flag.

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

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

updateExpireUserTargetDate

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

Parameters

• flagKey: The flag key
• variationId: ID of a variation on the flag
• value: The time, in Unix milliseconds, when LaunchDarkly should remove the user from individual targeting for this flag.
• version: 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 explicitly removed, or until another removal is scheduled.

Parameters

• flagKey: The flag key
• variationId: ID of a variation on the flag

PATCH /api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey}

Update expiring user target for flags

cURL

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

200

{
  "items": [
    {
      "_id": "12ab3c45de678910fgh12345",
      "_version": 1,
      "expirationDate": "1658192820000",
      "userKey": "example-user-key",
      "_resourceId": {
        "kind": "<string>",
        "projectKey": "<string>",
        "environmentKey": "<string>",
        "flagKey": "<string>",
        "key": "<string>"
      },
      "targetType": "included",
      "variationId": "ce67d625-a8b9-4fb5-a344-ab909d9d4f4d"
    }
  ],
  "_links": {},
  "totalInstructions": 1,
  "successfulInstructions": 1,
  "failedInstructions": 0,
  "errors": [
    {
      "instructionIndex": 1,
      "message": "example error message"
    }
  ]
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

userKey · string<string> · required

The user key

environmentKey · string<string> · required

The environment key

Body

application/json

instructions · object[] · required

The instructions to perform when updating

Show child attributes

comment · string

Optional comment describing the change

Example:

"optional comment"

Response

200

application/json

Expiring user target response

items · object[] · required

An array of expiring user targets

Show child attributes

_links · object

The location and content type of related resources

Show child attributes

totalInstructions · integer

The total count of instructions sent in the PATCH request

Example:

1

successfulInstructions · integer

The total count of successful instructions sent in the PATCH request

Example:

1

failedInstructions · integer

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

Example:

0

errors · object[]

An array of error messages for the failed instructions

Show child attributes