Create scheduled changes workflow
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.
Authorization
ApiKey read, writeIn: header
Scope: read, write
Path Parameters
The project key
stringThe feature flag key
stringThe environment key
stringQuery Parameters
Whether to succeed (true) or fail (false) when these instructions conflict with existing scheduled changes
Request Body
application/json
Optional comment describing the scheduled changes
When the scheduled changes should be executed
int64The 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.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/projects/string/flags/string/environments/string/scheduled-changes" \ -H "Content-Type: application/json" \ -d '{ "comment": "Optional comment describing the scheduled changes", "executionDate": 1718467200000, "instructions": [ { "kind": "turnFlagOn" } ] }'{ "_id": "12ab3c45de678910abc12345", "_creationDate": "1654123897062", "_maintainerId": "12ab3c45de678910abc12345", "_maintainerServiceTokenId": "string", "_version": 1, "executionDate": "1636558831870", "instructions": "[ { \"kind\": \"turnFlagOn\" }]", "conflicts": null, "_links": { "property1": { "href": "string", "type": "string" }, "property2": { "href": "string", "type": "string" } }}