Segments

Get a list of all user segments in the given project.

Create a new user segment.

Get a single user segment by key.

Update a user segment. The request body must be a valid semantic patch, JSON patch, or JSON merge patch.

Using semantic patches on a segment

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.

The body of a semantic patch request for updating segments requires an environmentKey in addition to instructions and an optional comment. The body of the request takes the following properties:

• comment (string): (Optional) A description of the update.
• environmentKey (string): (Required) The key of the LaunchDarkly environment.
• instructions (array): (Required) A list of actions the update should perform. Each action in the list must be an object with a kind property that indicates the instruction. If the action requires parameters, you must include those parameters as additional fields in the object.

Instructions

Semantic patch requests support the following kind instructions for updating segments.

addIncludedUsers

Adds user keys to the individual user targets included in the segment. Returns an error if this causes the same user key to be both included and excluded.

Parameters

• values: List of user keys.

addExcludedUsers

Adds user keys to the individual user targets excluded from the segment. Returns an error if this causes the same user key to be both included and excluded.

Parameters

• values: List of user keys.

removeIncludedUsers

Removes user keys from the individual user targets included in the segment.

Parameters

• values: List of user keys.

removeExcludedUsers

Removes user keys from the individual user targets excluded from the segment.

Parameters

• values: List of user keys.

updateName

Updates the name of the segment.

Parameters

• value: Name of the segment.

Using JSON patches on a segment

You can also use JSON patch. To learn more, read Updates using JSON patches.

For example, to update the description for a segment, use the following request body:

{
  "patch": [
    {
      "op": "replace",
      "path": "/description",
      "value": "new description"
    }
  ]
}

To update fields in the segment that are arrays, set the path to the name of the field and then append /<array index>. Using /0 adds the new entry to the beginning of the array.

For example, to add a rule to a segment, use the following request body:

{
  "patch":[
    {
      "op": "add",
      "path": "/rules/0",
      "value": {
        "clauses": [{ "attribute": "email", "op": "endsWith", "values": [".edu"], "negate": false }]
      }
    }
  ]
}

To add or remove users from segments, we recommend using semantic patch. Semantic patch for segments includes specific instructions for adding and removing both included and excluded users.

Delete a user segment.

Update targets included or excluded in a Big Segment.

Get the membership status (included/excluded) for a given user in this Big Segment. This operation does not support standard segments.

Get a list of a segment's user targets that are scheduled for removal.

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 user targets.

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.