Patch segment

PATCH
/api/v2/segments/:projectKey/:environmentKey/:segmentKey

Update a segment. The request body must be a valid semantic patch, JSON patch, or JSON merge patch. To learn more the different formats, read Updates.

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.

Click to expand instructions for updating segment details and settings

addTags

Adds tags to the segment.

Parameters
  • values: A list of tags to add.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "addTags",
4    "values": ["tag1", "tag2"]
5  }]
6}

removeTags

Removes tags from the segment.

Parameters
  • values: A list of tags to remove.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "removeTags",
4    "values": ["tag1", "tag2"]
5  }]
6}

updateName

Updates the name of the segment.

Parameters
  • value: Name of the segment.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "updateName",
4    "value": "Updated segment name"
5  }]
6}
Click to expand instructions for updating segment individual targets

addExcludedTargets

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

Parameters
  • contextKind: The context kind the targets should be added to.
  • values: List of keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "addExcludedTargets",
4    "contextKind": "org",
5    "values": [ "org-key-123abc", "org-key-456def" ]
6  }]
7}

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. If you are working with contexts, use addExcludedTargets instead of this instruction.

Parameters
  • values: List of user keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "addExcludedUsers",
4    "values": [ "user-key-123abc", "user-key-456def" ]
5  }]
6}

addIncludedTargets

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

Parameters
  • contextKind: The context kind the targets should be added to.
  • values: List of keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "addIncludedTargets",
4    "contextKind": "org",
5    "values": [ "org-key-123abc", "org-key-456def" ]
6  }]
7}

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. If you are working with contexts, use addIncludedTargets instead of this instruction.

Parameters
  • values: List of user keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "addIncludedUsers",
4    "values": [ "user-key-123abc", "user-key-456def" ]
5  }]
6}

removeExcludedTargets

Removes context keys from the individual context targets excluded from the segment for the specified contextKind.

Parameters
  • contextKind: The context kind the targets should be removed from.
  • values: List of keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "removeExcludedTargets",
4    "contextKind": "org",
5    "values": [ "org-key-123abc", "org-key-456def" ]
6  }]
7}

removeExcludedUsers

Removes user keys from the individual user targets excluded from the segment. If you are working with contexts, use removeExcludedTargets instead of this instruction.

Parameters
  • values: List of user keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "removeExcludedUsers",
4    "values": [ "user-key-123abc", "user-key-456def" ]
5  }]
6}

removeIncludedTargets

Removes context keys from the individual context targets included in the segment for the specified contextKind.

Parameters
  • contextKind: The context kind the targets should be removed from.
  • values: List of keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "removeIncludedTargets",
4    "contextKind": "org",
5    "values": [ "org-key-123abc", "org-key-456def" ]
6  }]
7}

removeIncludedUsers

Removes user keys from the individual user targets included in the segment. If you are working with contexts, use removeIncludedTargets instead of this instruction.

Parameters
  • values: List of user keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "removeIncludedUsers",
4    "values": [ "user-key-123abc", "user-key-456def" ]
5  }]
6}
Click to expand instructions for updating segment targeting rules

addClauses

Adds the given clauses to the rule indicated by ruleId.

Parameters
  • clauses: Array of clause objects, with contextKind (string), attribute (string), op (string), negate (boolean), and values (array of strings, numbers, or dates) properties. The contextKind, if not provided, defaults to user. The contextKind, attribute, and values are case sensitive. The op must be lower-case.
  • ruleId: ID of a rule in the segment.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "addClauses",
4    "clauses": [
5      {
6        "attribute": "email",
7        "negate": false,
8        "op": "contains",
9        "values": ["value1"]
10      }
11    ],
12    "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
13  }]
14}

addRule

Adds a new targeting rule to the segment. The rule may contain clauses.

Parameters
  • clauses: Array of clause objects, with contextKind (string), attribute (string), op (string), negate (boolean), and values (array of strings, numbers, or dates) properties. The contextKind, if not provided, defaults to user. The contextKind, attribute, and values are case sensitive. The op must be lower-case.
  • description: A description of the rule.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "addRule",
4    "clauses": [
5      {
6        "attribute": "email",
7        "op": "contains",
8        "negate": false,
9        "values": ["@launchdarkly.com"]
10      }
11    ],
12    "description": "Targeting rule for LaunchDarkly employees",
13  }]
14}

addValuesToClause

Adds values to the values of the clause that ruleId and clauseId indicate. Does not update the context kind, attribute, or operator.

Parameters
  • ruleId: ID of a rule in the segment.
  • clauseId: ID of a clause in that rule.
  • values: Array of strings, case sensitive.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "addValuesToClause",
4    "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
5    "clauseId": "10a58772-3121-400f-846b-b8a04e8944ed",
6    "values": ["beta_testers"]
7  }]
8}

removeClauses

Removes the clauses specified by clauseIds from the rule indicated by ruleId.

Parameters
  • ruleId: ID of a rule in the segment.
  • clauseIds: Array of IDs of clauses in the rule.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "removeClauses",
4    "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
5    "clauseIds": ["10a58772-3121-400f-846b-b8a04e8944ed", "36a461dc-235e-4b08-97b9-73ce9365873e"]
6  }]
7}

removeRule

Removes the targeting rule specified by ruleId. Does nothing if the rule does not exist.

Parameters
  • ruleId: ID of a rule in the segment.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "removeRule",
4    "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29"
5  }]
6}

removeValuesFromClause

Removes values from the values of the clause indicated by ruleId and clauseId. Does not update the context kind, attribute, or operator.

Parameters
  • ruleId: ID of a rule in the segment.
  • clauseId: ID of a clause in that rule.
  • values: Array of strings, case sensitive.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "removeValuesFromClause",
4    "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
5    "clauseId": "10a58772-3121-400f-846b-b8a04e8944ed",
6    "values": ["beta_testers"]
7  }]
8}

reorderRules

Rearranges the rules to match the order given in ruleIds. Returns an error if ruleIds does not match the current set of rules in the segment.

Parameters
  • ruleIds: Array of IDs of all targeting rules in the segment.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "reorderRules",
4    "ruleIds": ["a902ef4a-2faf-4eaf-88e1-ecc356708a29", "63c238d1-835d-435e-8f21-c8d5e40b2a3d"]
5  }]
6}

updateClause

Replaces the clause indicated by ruleId and clauseId with clause.

Parameters
  • ruleId: ID of a rule in the segment.
  • clauseId: ID of a clause in that rule.
  • clause: New clause object, with contextKind (string), attribute (string), op (string), negate (boolean), and values (array of strings, numbers, or dates) properties. The contextKind, if not provided, defaults to user. The contextKind, attribute, and values are case sensitive. The op must be lower-case.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "updateClause",
4    "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
5    "clauseId": "10c7462a-2062-45ba-a8bb-dfb3de0f8af5",
6    "clause": {
7      "contextKind": "user",
8      "attribute": "country",
9      "op": "in",
10      "negate": false,
11      "values": ["Mexico", "Canada"]
12    }
13  }]
14}

updateRuleDescription

Updates the description of the segment targeting rule.

Parameters
  • description: The new human-readable description for this rule.
  • ruleId: The ID of the rule. You can retrieve this by making a GET request for the segment.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "updateRuleDescription",
4    "description": "New rule description",
5    "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29"
6  }]
7}

updateRuleRolloutAndContextKind

For a rule that includes a percentage of targets, updates the percentage and the context kind of the targets to include.

Parameters
  • ruleId: The ID of a targeting rule in the segment that includes a percentage of targets.
  • weight: The weight, in thousandths of a percent (0-100000).
  • contextKind: The context kind.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "reorderRules",
4    "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
5    "weight": "20000",
6    "contextKind": "device"
7  }]
8}
Click to expand instructions for working with Big Segments

A “big segment” is a segment that is either a synced segment, or a list-based segment with more than 15,000 entries that includes only one targeted context kind. LaunchDarkly uses different implementations for different types of segments so that all of your segments have good performance.

The following semantic patch instructions apply only to these larger list-based segments.

addBigSegmentExcludedTargets

For use with larger list-based segments ONLY. Adds context keys to the context targets excluded from the segment. Returns an error if this causes the same context key to be both included and excluded.

Parameters
  • values: List of context keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "addBigSegmentExcludedTargets",
4    "values": [ "org-key-123abc", "org-key-456def" ]
5  }]
6}

addBigSegmentIncludedTargets

For use with larger list-based segments ONLY. Adds context keys to the context targets included in the segment. Returns an error if this causes the same context key to be both included and excluded.

Parameters
  • values: List of context keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "addBigSegmentIncludedTargets",
4    "values": [ "org-key-123abc", "org-key-456def" ]
5  }]
6}

processBigSegmentImport

For use with larger list-based segments ONLY. Processes a segment import.

Parameters
  • importId: The ID of the import. The import ID is returned in the Location header as part of the Create big segment import request.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "processBigSegmentImport",
4    "importId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29"
5  }]
6}

removeBigSegmentExcludedTargets

For use with larger list-based segments ONLY. Removes context keys from the context targets excluded from the segment.

Parameters
  • values: List of context keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "removeBigSegmentExcludedTargets",
4    "values": [ "org-key-123abc", "org-key-456def" ]
5  }]
6}

removeBigSegmentIncludedTargets

For use with larger list-based segments ONLY. Removes context keys from the context targets included in the segment.

Parameters
  • values: List of context keys.

Here’s an example:

1{
2  "instructions": [{
3    "kind": "removeBigSegmentIncludedTargets",
4    "values": [ "org-key-123abc", "org-key-456def" ]
5  }]
6}

Using JSON patches on a segment

If you do not include the header described above, you can use a JSON patch or JSON merge patch representation of the desired changes.

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

1{
2  "patch": [
3    {
4      "op": "replace",
5      "path": "/description",
6      "value": "new description"
7    }
8  ]
9}

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

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

1{
2  "patch":[
3    {
4      "op": "add",
5      "path": "/rules/0",
6      "value": {
7        "clauses": [{ "contextKind": "user", "attribute": "email", "op": "endsWith", "values": [".edu"], "negate": false }]
8      }
9    }
10  ]
11}

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

Path parameters

projectKeystringRequired

The project key

environmentKeystringRequired

The environment key

segmentKeystringRequired

The segment key

Request

This endpoint expects an object.
patchlist of objectsRequired

A JSON patch representation of the change to make

commentstringOptional

Optional comment

Response

Segment response

namestring

A human-friendly name for the segment.

tagslist of strings

Tags for the segment. Defaults to an empty array.

creationDatelong

Timestamp of when the segment was created

lastModifiedDatelong

Timestamp of when the segment was last modified

keystring

A unique key used to reference the segment

_linksmap from strings to objects

The location and content type of related resources

ruleslist of objects

An array of the targeting rules for this segment.

versioninteger

Version of the segment

deletedboolean

Whether the segment has been deleted

generationinteger

For big segments, how many times this segment has been created.

descriptionstringOptional

A description of the segment’s purpose. Defaults to null and is omitted in the response if not provided.

includedlist of stringsOptional

An array of keys for included targets. Included individual targets are always segment members, regardless of segment rules. For list-based segments over 15,000 entries, also called big segments, this array is either empty or omitted.

excludedlist of stringsOptional

An array of keys for excluded targets. Segment rules bypass individual excluded targets, so they will never be included based on rules. Excluded targets may still be included explicitly. This value is omitted for list-based segments over 15,000 entries, also called big segments.

includedContextslist of objectsOptional
excludedContextslist of objectsOptional
_accessobjectOptional
_flagslist of objectsOptional

A list of flags targeting this segment. Only included when getting a single segment, using the getSegment endpoint.

unboundedbooleanOptional

Whether this is a standard segment (false) or a big segment (true). Standard segments include rule-based segments and smaller list-based segments. Big segments include larger list-based segments and synced segments. If omitted, the segment is a standard segment.

unboundedContextKindstringOptional

For big segments, the targeted context kind.

_unboundedMetadataobjectOptional

Details on the external data store backing this segment. Only applies to big segments.

_externalstringOptional

The external data store backing this segment. Only applies to synced segments.

_externalLinkstringOptional

The URL for the external data store backing this segment. Only applies to synced segments.

_importInProgressbooleanOptional

Whether an import is currently in progress for the specified segment. Only applies to big segments.

Errors

Update context targets on a big segment
Built with