Create scheduled changes workflow

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

Create scheduled changes for a feature flag. The changes you schedule may include any semantic patch instructions available when updating a feature flag. If the ignoreConflicts query parameter is false and there are conflicts between these instructions and existing scheduled changes, the request will fail. If the parameter is true and there are conflicts, the request will succeed.

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

Create scheduled changes workflow

cURL

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

201

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

Query Parameters

ignoreConflicts · boolean

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

Body

application/json

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. This should be an array with a single object that looks like {"kind": "scheduled_action"}. Supported scheduled actions include any semantic patch instructions available when updating a feature flag.

Show child attributes

Example:

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

comment · string

Optional comment describing the scheduled changes

Example:

"optional comment"

Response

201

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