v5

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

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.

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:

{
  "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:

{
  "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:

{
  "instructions": [
    {
      "kind": "updateScheduledChangesExecutionDate",
      "value": 1754092860000
    }
  ]
}
</details>
patch/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}

Path parameters

projectKeystring string required

The project key

The project key

featureFlagKeystring string required

The feature flag key

The feature flag key

environmentKeystring string required

The environment key

The environment key

idstring string required

The scheduled change ID

The scheduled change ID

Query parameters

ignoreConflictsboolean

Whether to succeed (true) or fail (false) when these new instructions conflict with existing scheduled changes

Whether to succeed (true) or fail (false) when these new instructions conflict with existing scheduled changes

Request body

commentstring

Optional comment describing the update to the scheduled changes

instructionsInstruction[] required

Example request

{
  "comment": "optional comment"
}

Response

Scheduled changes response

_idstring required
_creationDateinteger required
_maintainerIdstring required

The ID of the scheduled change maintainer

_versioninteger required

Version of the scheduled change

executionDateinteger required
instructionsInstruction[] required
{"stackTrail":"components:schemas:FeatureFlagScheduledChange:properties:conflicts","oasType":"schema","type":"unknown","description":"Details on any conflicting scheduled changes"}
_linksobject

The location and content type of related resources

Example response

{
  "_maintainerId": "12ab3c45de678910abc12345",
  "_version": 1
}