Update expiring targets for segment

PATCH

/api/v2/segments/:projectKey/:segmentKey/expiring-targets/:environmentKey

PATCH

/api/v2/segments/:projectKey/:segmentKey/expiring-targets/:environmentKey

$ curl -X PATCH https://app.launchdarkly.com/api/v2/segments/projectKey/segmentKey/expiring-targets/environmentKey \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "instructions": [
>     {
>       "kind": "updateExpiringTarget",
>       "contextKey": "user@email.com",
>       "contextKind": "user",
>       "targetType": "included",
>       "value": 1587582000000,
>       "version": 0
>     }
>   ]
> }'

1 {
2   "items": [
3     {
4       "_id": "12ab3c45de678910abc12345",
5       "_version": 1,
6       "expirationDate": 1672358400000,
7       "contextKind": "user",
8       "contextKey": "context-key-123abc",
9       "_resourceId": {
10         "environmentKey": "environment-key-123abc",
11         "key": "segment-key-123abc",
12         "kind": "segment",
13         "projectKey": "project-key-123abc",
14         "flagKey": "string"
15       },
16       "targetType": "included",
17       "variationId": "cc4332e2-bd4d-4fe0-b509-dfd2caf8dd73"
18     }
19   ],
20   "_links": {},
21   "totalInstructions": 1,
22   "successfulInstructions": 1,
23   "failedInstructions": 1,
24   "errors": [
25     {
26       "instructionIndex": 1,
27       "message": "example error message"
28     }
29   ]
30 }

Update expiring context targets for a segment. Updating a context 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](https://launchdarkly.com/docs/api#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 context targets. <details> <summary>Click to expand instructions for <strong>updating expiring context targets</strong></summary> #### addExpiringTarget Schedules a date and time when LaunchDarkly will remove a context from segment targeting. The segment must already have the context as an individual target. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. - `value`: The date when the context should expire from the segment targeting, in Unix milliseconds. Here's an example: ```json { "instructions": [{ "kind": "addExpiringTarget", "targetType": "included", "contextKey": "user-key-123abc", "contextKind": "user", "value": 1754092860000 }] } ``` #### updateExpiringTarget Updates the date and time when LaunchDarkly will remove a context from segment targeting. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. - `value`: The new date when the context should expire from the segment targeting, in Unix milliseconds. - `version`: (Optional) The version of the expiring target to update. If included, update will fail if version doesn't match current version of the expiring target. Here's an example: ```json { "instructions": [{ "kind": "updateExpiringTarget", "targetType": "included", "contextKey": "user-key-123abc", "contextKind": "user", "value": 1754179260000 }] } ``` #### removeExpiringTarget Removes the scheduled expiration for the context in the segment. ##### Parameters - `targetType`: The type of individual target for this context. Must be either `included` or `excluded`. - `contextKey`: The context key. - `contextKind`: The kind of context being targeted. Here's an example: ```json { "instructions": [{ "kind": "removeExpiringTarget", "targetType": "included", "contextKey": "user-key-123abc", "contextKind": "user", }] } ``` </details>

Update expiring targets for segment

PATCH

/api/v2/segments/:projectKey/:segmentKey/expiring-targets/:environmentKey

PATCH

/api/v2/segments/:projectKey/:segmentKey/expiring-targets/:environmentKey

$ curl -X PATCH https://app.launchdarkly.com/api/v2/segments/projectKey/segmentKey/expiring-targets/environmentKey \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "instructions": [
>     {
>       "kind": "updateExpiringTarget",
>       "contextKey": "user@email.com",
>       "contextKind": "user",
>       "targetType": "included",
>       "value": 1587582000000,
>       "version": 0
>     }
>   ]
> }'

1 {
2   "items": [
3     {
4       "_id": "12ab3c45de678910abc12345",
5       "_version": 1,
6       "expirationDate": 1672358400000,
7       "contextKind": "user",
8       "contextKey": "context-key-123abc",
9       "_resourceId": {
10         "environmentKey": "environment-key-123abc",
11         "key": "segment-key-123abc",
12         "kind": "segment",
13         "projectKey": "project-key-123abc",
14         "flagKey": "string"
15       },
16       "targetType": "included",
17       "variationId": "cc4332e2-bd4d-4fe0-b509-dfd2caf8dd73"
18     }
19   ],
20   "_links": {},
21   "totalInstructions": 1,
22   "successfulInstructions": 1,
23   "failedInstructions": 1,
24   "errors": [
25     {
26       "instructionIndex": 1,
27       "message": "example error message"
28     }
29   ]
30 }

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

Click to expand instructions for updating expiring context targets

addExpiringTarget

Schedules a date and time when LaunchDarkly will remove a context from segment targeting. The segment must already have the context as an individual target.

Parameters

targetType: The type of individual target for this context. Must be either included or excluded.
contextKey: The context key.
contextKind: The kind of context being targeted.
value: The date when the context should expire from the segment targeting, in Unix milliseconds.

Here’s an example:

1 {
2   "instructions": [{
3     "kind": "addExpiringTarget",
4     "targetType": "included",
5     "contextKey": "user-key-123abc",
6     "contextKind": "user",
7     "value": 1754092860000
8   }]
9 }

updateExpiringTarget

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

Parameters

targetType: The type of individual target for this context. Must be either included or excluded.
contextKey: The context key.
contextKind: The kind of context being targeted.
value: The new date when the context should expire from the segment targeting, in Unix milliseconds.
version: (Optional) The version of the expiring target to update. If included, update will fail if version doesn’t match current version of the expiring target.

Here’s an example:

1 {
2   "instructions": [{
3     "kind": "updateExpiringTarget",
4     "targetType": "included",
5     "contextKey": "user-key-123abc",
6     "contextKind": "user",
7     "value": 1754179260000
8   }]
9 }

removeExpiringTarget

Removes the scheduled expiration for the context in the segment.

Parameters

targetType: The type of individual target for this context. Must be either included or excluded.
contextKey: The context key.
contextKind: The kind of context being targeted.

Here’s an example:

1 {
2   "instructions": [{
3     "kind": "removeExpiringTarget",
4     "targetType": "included",
5     "contextKey": "user-key-123abc",
6     "contextKind": "user",
7   }]
8 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

environmentKeystringRequiredformat: "string"

The environment key

segmentKeystringRequiredformat: "string"

The segment key

Request

This endpoint expects an object.

instructionslist of objectsRequired

Semantic patch instructions for the desired changes to the resource

commentstringOptional

Optional description of changes

Response

Expiring target response

itemslist of objects

A list of the results from each instruction

_linksmap from strings to objects

The location and content type of related resources

totalInstructionsinteger

successfulInstructionsinteger

failedInstructionsinteger

errorslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

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

Click to expand instructions for updating expiring context targets

addExpiringTarget

Schedules a date and time when LaunchDarkly will remove a context from segment targeting. The segment must already have the context as an individual target.

Parameters

targetType: The type of individual target for this context. Must be either included or excluded.
contextKey: The context key.
contextKind: The kind of context being targeted.
value: The date when the context should expire from the segment targeting, in Unix milliseconds.

Here’s an example:

1 {
2   "instructions": [{
3     "kind": "addExpiringTarget",
4     "targetType": "included",
5     "contextKey": "user-key-123abc",
6     "contextKind": "user",
7     "value": 1754092860000
8   }]
9 }

updateExpiringTarget

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

Parameters

targetType: The type of individual target for this context. Must be either included or excluded.
contextKey: The context key.
contextKind: The kind of context being targeted.
value: The new date when the context should expire from the segment targeting, in Unix milliseconds.
version: (Optional) The version of the expiring target to update. If included, update will fail if version doesn’t match current version of the expiring target.

Here’s an example:

1 {
2   "instructions": [{
3     "kind": "updateExpiringTarget",
4     "targetType": "included",
5     "contextKey": "user-key-123abc",
6     "contextKind": "user",
7     "value": 1754179260000
8   }]
9 }

removeExpiringTarget

Removes the scheduled expiration for the context in the segment.

Parameters

targetType: The type of individual target for this context. Must be either included or excluded.
contextKey: The context key.
contextKind: The kind of context being targeted.

Here’s an example:

1 {
2   "instructions": [{
3     "kind": "removeExpiringTarget",
4     "targetType": "included",
5     "contextKey": "user-key-123abc",
6     "contextKind": "user",
7   }]
8 }

$	curl -X PATCH https://app.launchdarkly.com/api/v2/segments/projectKey/segmentKey/expiring-targets/environmentKey \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"instructions": [
>	{
>	"kind": "updateExpiringTarget",
>	"contextKey": "user@email.com",
>	"contextKind": "user",
>	"targetType": "included",
>	"value": 1587582000000,
>	"version": 0
>	}
>	]
>	}'

1	{
2	"items": [
3	{
4	"_id": "12ab3c45de678910abc12345",
5	"_version": 1,
6	"expirationDate": 1672358400000,
7	"contextKind": "user",
8	"contextKey": "context-key-123abc",
9	"_resourceId": {
10	"environmentKey": "environment-key-123abc",
11	"key": "segment-key-123abc",
12	"kind": "segment",
13	"projectKey": "project-key-123abc",
14	"flagKey": "string"
15	},
16	"targetType": "included",
17	"variationId": "cc4332e2-bd4d-4fe0-b509-dfd2caf8dd73"
18	}
19	],
20	"_links": {},
21	"totalInstructions": 1,
22	"successfulInstructions": 1,
23	"failedInstructions": 1,
24	"errors": [
25	{
26	"instructionIndex": 1,
27	"message": "example error message"
28	}
29	]
30	}

1	{
2	"instructions": [{
3	"kind": "addExpiringTarget",
4	"targetType": "included",
5	"contextKey": "user-key-123abc",
6	"contextKind": "user",
7	"value": 1754092860000
8	}]
9	}

1	{
2	"instructions": [{
3	"kind": "removeExpiringTarget",
4	"targetType": "included",
5	"contextKey": "user-key-123abc",
6	"contextKind": "user",
7	}]
8	}