Update scheduled changes workflow

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

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.

Click to expand instructions for updating scheduled changes

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
    }
  ]
}

PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id}

Update scheduled changes workflow

cURL

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "Optional comment describing the update to the scheduled changes",
  "instructions": [
    {
      "kind": "replaceScheduledChangesInstructions",
      "value": [
        {
          "kind": "turnFlagOff"
        }
      ]
    }
  ]
}
'

200

{
  "_id": "12ab3c45de678910abc12345",
  "_creationDate": "1654123897062",
  "_maintainerId": "12ab3c45de678910abc12345",
  "_version": 1,
  "executionDate": "1636558831870",
  "instructions": "[ { \"kind\": \"turnFlagOn\" }]",
  "conflicts": "<unknown>",
  "_links": {}
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

featureFlagKey · string<string> · required

The feature flag key

environmentKey · string<string> · required

The environment key

id · string<string> · required

The scheduled change ID

Query Parameters

ignoreConflicts · boolean

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

Body

application/json

instructions · object[] · required

The instructions to perform when updating. This should be an array with objects that look like {"kind": "update_action"}. Some instructions also require a value field in the array element.

Show child attributes

Example:

"[ { \"kind\": \"replaceScheduledChangesInstructions\", \"value\": [ { \"kind\": \"turnFlagOff\" } ] } ]"

comment · string

Optional comment describing the update to the scheduled changes

Example:

"optional comment"

Response

200

application/json

Scheduled changes response

_id · string · required

The ID of this scheduled change

Example:

"12ab3c45de678910abc12345"

_creationDate · integer<int64> · required

Timestamp of when the scheduled change was created

Example:

"1654123897062"

_maintainerId · string · required

The ID of the scheduled change maintainer

Example:

"12ab3c45de678910abc12345"

_version · integer · required

Version of the scheduled change

Example:

1

executionDate · integer<int64> · required

When the scheduled changes should be executed

Example:

"1636558831870"

instructions · object[] · required

The actions to perform on the execution date for these scheduled changes

Show child attributes

Example:

"[ { \"kind\": \"turnFlagOn\" }]"

conflicts · any

Details on any conflicting scheduled changes

_links · object

The location and content type of related resources

Show child attributes