Update expiring user target for flags

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

1 curl -X PATCH https://app.launchdarkly.com/api/v2/users/projectKey/userKey/expiring-user-targets/environmentKey \ 2 -H "Authorization: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "instructions": [ 6 { 7 "kind": "addExpireUserTargetDate", 8 "flagKey": "sample-flag-key", 9 "variationId": "ce12d345-a1b2-4fb5-a123-ab123d4d5f5d" 10 } 11 ] 12 }'

1 { 2 "items": [ 3 { 4 "_id": "12ab3c45de678910fgh12345", 5 "_version": 1, 6 "expirationDate": 1000000, 7 "userKey": "example-user-key", 8 "_resourceId": {}, 9 "targetType": "included", 10 "variationId": "ce67d625-a8b9-4fb5-a344-ab909d9d4f4d" 11 } 12 ], 13 "_links": { 14 "key": { 15 "href": "href", 16 "type": "type" 17 } 18 }, 19 "totalInstructions": 1, 20 "successfulInstructions": 1, 21 "failedInstructions": 0, 22 "errors": [ 23 { 24 "instructionIndex": 1, 25 "message": "example error message" 26 } 27 ] 28 }

Instructions

addExpireUserTargetDate

Parameters

updateExpireUserTargetDate

Parameters

removeExpireUserTargetDate

Parameters

Path parameters

Request

Response

Errors

1	curl -X PATCH https://app.launchdarkly.com/api/v2/users/projectKey/userKey/expiring-user-targets/environmentKey \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"instructions": [
6	{
7	"kind": "addExpireUserTargetDate",
8	"flagKey": "sample-flag-key",
9	"variationId": "ce12d345-a1b2-4fb5-a123-ab123d4d5f5d"
10	}
11	]
12	}'

1	{
2	"items": [
3	{
4	"_id": "12ab3c45de678910fgh12345",
5	"_version": 1,
6	"expirationDate": 1000000,
7	"userKey": "example-user-key",
8	"_resourceId": {},
9	"targetType": "included",
10	"variationId": "ce67d625-a8b9-4fb5-a344-ab909d9d4f4d"
11	}
12	],
13	"_links": {
14	"key": {
15	"href": "href",
16	"type": "type"
17	}
18	},
19	"totalInstructions": 1,
20	"successfulInstructions": 1,
21	"failedInstructions": 0,
22	"errors": [
23	{
24	"instructionIndex": 1,
25	"message": "example error message"
26	}
27	]
28	}