Create scheduled changes workflow | LaunchDarkly

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

{
  "_id": "12ab3c45de678910abc12345",
  "_creationDate": 1654123897062,
  "_maintainerId": "12ab3c45de678910abc12345",
  "_version": 1,
  "executionDate": 1636558831870,
  "instructions": [
    "[ { \"kind\": \"turnFlagOn\" }]"
  ],
  "_maintainerServiceTokenId": "string",
  "conflicts": null,
  "_links": {}
}

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.

Create scheduled changes for a feature flag. The changes you schedule may include any semantic patch instructions available when [updating a feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-feature-flag#using-semantic-patches-on-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.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

featureFlagKeystringRequiredformat: "string"

The feature flag key

environmentKeystringRequiredformat: "string"

The environment key

Query parameters

ignoreConflictsbooleanOptional

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

Request

This endpoint expects an object.

executionDatelongRequired

When the scheduled changes should be executed

instructionslist of maps from strings to anyRequired

The actions to perform on the execution date for these scheduled changes. This should be an array with a single object that looks like <code>{“kind”: “scheduled_action”}</code>. Supported scheduled actions include any semantic patch instructions available when updating a feature flag.

commentstringOptional

Optional comment describing the scheduled changes

Response

Scheduled changes response

_idstring

The ID of this scheduled change

_creationDatelong

Timestamp of when the scheduled change was created

_maintainerIdstring

The ID of the scheduled change maintainer

_versioninteger

Version of the scheduled change

executionDatelong

When the scheduled changes should be executed

instructionslist of maps from strings to any

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

_maintainerServiceTokenIdstring

The ID of the service token that created or updated this scheduled change

conflictsany

Details on any conflicting scheduled changes

_linksmap from strings to objects

The location and content type of related resources

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

405

Method Not Allowed Error

409

Conflict Error

429

Too Many Requests Error