Update expiring user target for flags | LaunchDarkly

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

{
  "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"
    }
  ]
}

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](https://launchdarkly.com/docs/api#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 * `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 </details>

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

{
  "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"
    }
  ]
}

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

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

userKeystringRequiredformat: "string"

The user key

environmentKeystringRequiredformat: "string"

The environment key

Request

This endpoint expects an object.

instructionslist of objectsRequired

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

_linksmap from strings to objects

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

errorslist of objects

An array of error messages for the failed instructions

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

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

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