v5

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

Segments

Update expiring user targets for segment

Contexts are now available

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

Update expiring user targets for a segment. Updating a user target expiration 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.

If the request is well-formed but any of its instructions failed to process, this operation returns status code 200. In this case, the response errors array will be non-empty.

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

Schedules a date and time when LaunchDarkly will remove a user from segment targeting.

Parameters

targetType: A segment's target type, must be either included or excluded.
userKey: The user key.
value: The date when the user should expire from the segment targeting, in Unix milliseconds.

updateExpireUserTargetDate

Updates the date and time when LaunchDarkly will remove a user from segment targeting.

Parameters

targetType: A segment's target type, must be either included or excluded.
userKey: The user key.
value: The new date when the user should expire from the segment targeting, in Unix milliseconds.
version: The segment version.

removeExpireUserTargetDate

Removes the scheduled expiration for the user in the segment.

Parameters

targetType: A segment's target type, must be either included or excluded.
userKey: The user key.

</details>

patch/api/v2/segments/{projectKey}/{segmentKey}/expiring-user-targets/{environmentKey}

Path parameters

projectKeystring string required

The project key

environmentKeystring string required

The environment key

segmentKeystring string required

The segment key

Request body

commentstring

Optional description of changes

Example request

{
  "comment": "optional comment",
  "instructions": [
    {
      "contextKey": "contextKey",
      "contextKind": "user",
      "kind": "updateExpiringTarget",
      "targetType": "included",
      "value": 1587582000000,
      "version": 0
    }
  ]
}

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