provider Scheduled changes PATCH
/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} @utdk/launchdarkly
/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} Update scheduled changes workflow
Update a scheduled change, overriding existing instructions with the new ones. Updating a scheduled change 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 scheduled changes.
<details>
<summary>Click to expand instructions for <strong>updating scheduled changes</strong></summary>
#### deleteScheduledChange
Removes the scheduled change.
Here's an example:
```json
{
"instructions": [{ "kind": "deleteScheduledChange" }]
}
```
#### replaceScheduledChangesInstructions
Removes the existing scheduled changes and replaces them with the new instructions.
##### Parameters
- `value`: An array of the new actions to perform when the execution date for these scheduled changes arrives. Supported scheduled actions are `turnFlagOn` and `turnFlagOff`.
Here's an example that replaces the scheduled changes with new instructions to turn flag targeting off:
```json
{
"instructions": [
{
"kind": "replaceScheduledChangesInstructions",
"value": [ {"kind": "turnFlagOff"} ]
}
]
}
```
#### updateScheduledChangesExecutionDate
Updates the execution date for the scheduled changes.
##### Parameters
- `value`: the new execution date, in Unix milliseconds.
Here's an example:
```json
{
"instructions": [
{
"kind": "updateScheduledChangesExecutionDate",
"value": 1754092860000
}
]
}
```
</details>
- projectKey path required
- The project key
- string
- featureFlagKey path required
- The feature flag key
- string
- environmentKey path required
- The environment key
- string
- id path required
- The scheduled change ID
- string
- ignoreConflicts query
- Whether to succeed (`true`) or fail (`false`) when these new instructions conflict with existing scheduled changes
- boolean
Try it
Authentication
Configure credentials for LaunchDarkly REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import launchdarkly from '@utdk/launchdarkly';
await launchdarkly.patchflagconfigscheduledchange()