Patch experiment
Update an experiment. Updating an experiment 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 experiments.
updateName
Updates the experiment name.
Parameters
value
: The new name.
Here’s an example:
updateDescription
Updates the experiment description.
Parameters
value
: The new description.
Here’s an example:
startIteration
Starts a new iteration for this experiment. You must create a new iteration before calling this instruction.
An iteration may not be started until it meets the following criteria:
- Its associated flag is toggled on and is not archived
- Its
randomizationUnit
is set - At least one of its
treatments
has a non-zeroallocationPercent
Parameters
changeJustification
: The reason for starting a new iteration. Required when you callstartIteration
on an already running experiment, otherwise optional.
Here’s an example:
stopIteration
Stops the current iteration for this experiment.
Parameters
winningTreatmentId
: The ID of the winning treatment. Treatment IDs are returned as part of the Get experiment response. They are the_id
of each element in thetreatments
array.winningReason
: The reason for the winner
Here’s an example:
archiveExperiment
Archives this experiment. Archived experiments are hidden by default in the LaunchDarkly user interface. You cannot start new iterations for archived experiments.
Here’s an example:
restoreExperiment
Restores an archived experiment. After restoring an experiment, you can start new iterations for it again.
Here’s an example:
Path parameters
Headers
Request
The instructions to perform when updating. This should be an array with objects that look like <code>{“kind”: “update_action”}</code>. Some instructions also require a <code>value</code> field in the array element.