Set an experiment's schedule and shipping automation
Full-replace of the experiment’s scheduled start/end and end-of-experiment shipping automation. The body is the complete desired state: any omitted field is cleared (omit startAt to remove a scheduled start; send an empty body to clear the whole schedule). Provide either stopAt or stopAfter, not both; a relative stopAfter resolves to a concrete stop when the experiment starts. Setting a scheduled end (stopAt or stopAfter) requires a scheduledStopPlan (any mode, including notify). The scheduled end must be in the future: a stopAt (or a stopAfter that resolves) in the past is rejected — including one whose end date has already passed and been acted on, so changing the plan after a soft end requires committing to a new end date. Auto-ship shipping requires the Decision Framework.
PUT
/
v1
/
experiments
/
{id}
/
schedule
cURL
curl -X PUT 'https://api.growthbook.io/api/v1/experiments/exp_abc123/schedule' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"startAt":"2026-08-01T00:00:00Z","stopAfter":{"value":14,"unit":"days"},"scheduledStopPlan":{"mode":"auto-ship","tiebreakerMetricId":"met_revenue","fallback":"force-ship","fallbackVariationId":"var_treatment"}}'import requests
url = "https://api.growthbook.io/api/v1/experiments/{id}/schedule"
payload = {
"startAt": "2023-11-07T05:31:56Z",
"stopAt": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({startAt: '2023-11-07T05:31:56Z', stopAt: '2023-11-07T05:31:56Z'})
};
fetch('https://api.growthbook.io/api/v1/experiments/{id}/schedule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.growthbook.io/api/v1/experiments/{id}/schedule",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'startAt' => '2023-11-07T05:31:56Z',
'stopAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.growthbook.io/api/v1/experiments/{id}/schedule"
payload := strings.NewReader("{\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"stopAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.growthbook.io/api/v1/experiments/{id}/schedule")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"stopAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/experiments/{id}/schedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"stopAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"experiment": {
"id": "<string>",
"trackingKey": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"name": "<string>",
"type": "standard",
"project": "<string>",
"hypothesis": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"owner": "<string>",
"archived": true,
"status": "<string>",
"autoRefresh": true,
"hashAttribute": "<string>",
"hashVersion": 1,
"variations": [
{
"variationId": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"screenshots": [
"<string>"
]
}
],
"phases": [
{
"name": "<string>",
"dateStarted": "<string>",
"dateEnded": "<string>",
"reasonForStopping": "<string>",
"seed": "<string>",
"coverage": 123,
"trafficSplit": [
{
"variationId": "<string>",
"weight": 123
}
],
"targetingCondition": "<string>",
"namespace": {
"namespaceId": "<string>",
"enabled": true,
"range": [
123
],
"ranges": [
[
123,
123
]
]
},
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"savedGroupTargeting": [
{
"matchType": "all",
"savedGroups": [
"<string>"
]
}
]
}
],
"settings": {
"datasourceId": "<string>",
"assignmentQueryId": "<string>",
"experimentId": "<string>",
"segmentId": "<string>",
"queryFilter": "<string>",
"inProgressConversions": "include",
"attributionModel": "firstExposure",
"statsEngine": "bayesian",
"goals": [
{
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"window": "conversion",
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
],
"secondaryMetrics": [
{
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"window": "conversion",
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
],
"guardrails": [
{
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"window": "conversion",
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
],
"lookbackOverride": {
"type": "date",
"value": 123,
"valueUnit": "minutes"
},
"regressionAdjustmentEnabled": true,
"sequentialTestingEnabled": true,
"sequentialTestingTuningParameter": 123,
"postStratificationEnabled": true,
"decisionFrameworkSettings": {
"decisionCriteriaId": "<string>",
"decisionFrameworkMetricOverrides": [
{
"id": "<string>",
"targetMDE": 123
}
]
},
"metricOverrides": [
{
"id": "<string>",
"windowType": "conversion",
"windowHours": 123,
"delayHours": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
],
"activationMetric": {
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"window": "conversion",
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
},
"ownerEmail": "<string>",
"fallbackAttribute": "<string>",
"disableStickyBucketing": true,
"bucketVersion": 123,
"minBucketVersion": 123,
"resultSummary": {
"status": "<string>",
"winner": "<string>",
"conclusions": "<string>",
"releasedVariationId": "<string>",
"excludeFromPayload": true
},
"shareLevel": "public",
"publicUrl": "<string>",
"banditScheduleValue": 123,
"banditScheduleUnit": "days",
"banditBurnInValue": 123,
"banditBurnInUnit": "days",
"banditConversionWindowValue": 123,
"banditConversionWindowUnit": "days",
"linkedFeatures": [
"<string>"
],
"attributeScopeAllProjects": true,
"hasVisualChangesets": true,
"hasURLRedirects": true,
"customFields": {},
"customMetricSlices": [
{
"slices": [
{
"column": "<string>",
"levels": [
"<string>"
]
}
]
}
],
"precomputedUnitDimensionIds": [
"<string>"
],
"defaultDashboardId": "<string>",
"templateId": "<string>",
"statusUpdateSchedule": {
"startAt": "2023-11-07T05:31:56Z",
"stopAt": "2023-11-07T05:31:56Z",
"stopAfter": {
"value": 123,
"unit": "hours"
},
"scheduledStopPlan": {
"mode": "notify",
"tiebreakerMetricId": "<string>",
"fallback": "notify",
"fallbackVariationId": "<string>"
}
},
"nextScheduledStatusUpdate": {
"type": "start",
"date": "2023-11-07T05:31:56Z"
},
"enhancedStatus": {
"status": "Running",
"detailedStatus": "<string>"
}
},
"warnings": [
"<string>"
]
}{
"message": "<string>",
"code": "invalid_status",
"details": {
"currentStatus": "<string>",
"expectedStatuses": [
"<string>"
]
}
}Authorizations
bearerAuthbasicAuth
If using Bearer auth, pass the Secret Key as the token:
curl https://api.growthbook.io/api/v1/features -H "Authorization: Bearer secret_abc123DEF456"
Path Parameters
The id of the requested resource
Body
application/json
ISO datetime when the experiment should start; must be in the future. Omit to clear a scheduled start. Staging still happens via POST /experiments/{id}/start.
Absolute ISO datetime to stop the experiment.
Deferred relative end, resolved to a concrete stop at the experiment's actual start (or now, if already running).
Show child attributes
Show child attributes
End-of-experiment automation. Required whenever a stopAt or stopAfter is set (any mode, including notify).
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl -X PUT 'https://api.growthbook.io/api/v1/experiments/exp_abc123/schedule' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"startAt":"2026-08-01T00:00:00Z","stopAfter":{"value":14,"unit":"days"},"scheduledStopPlan":{"mode":"auto-ship","tiebreakerMetricId":"met_revenue","fallback":"force-ship","fallbackVariationId":"var_treatment"}}'import requests
url = "https://api.growthbook.io/api/v1/experiments/{id}/schedule"
payload = {
"startAt": "2023-11-07T05:31:56Z",
"stopAt": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({startAt: '2023-11-07T05:31:56Z', stopAt: '2023-11-07T05:31:56Z'})
};
fetch('https://api.growthbook.io/api/v1/experiments/{id}/schedule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.growthbook.io/api/v1/experiments/{id}/schedule",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'startAt' => '2023-11-07T05:31:56Z',
'stopAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.growthbook.io/api/v1/experiments/{id}/schedule"
payload := strings.NewReader("{\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"stopAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.growthbook.io/api/v1/experiments/{id}/schedule")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"stopAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/experiments/{id}/schedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"stopAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"experiment": {
"id": "<string>",
"trackingKey": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"name": "<string>",
"type": "standard",
"project": "<string>",
"hypothesis": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"owner": "<string>",
"archived": true,
"status": "<string>",
"autoRefresh": true,
"hashAttribute": "<string>",
"hashVersion": 1,
"variations": [
{
"variationId": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"screenshots": [
"<string>"
]
}
],
"phases": [
{
"name": "<string>",
"dateStarted": "<string>",
"dateEnded": "<string>",
"reasonForStopping": "<string>",
"seed": "<string>",
"coverage": 123,
"trafficSplit": [
{
"variationId": "<string>",
"weight": 123
}
],
"targetingCondition": "<string>",
"namespace": {
"namespaceId": "<string>",
"enabled": true,
"range": [
123
],
"ranges": [
[
123,
123
]
]
},
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"savedGroupTargeting": [
{
"matchType": "all",
"savedGroups": [
"<string>"
]
}
]
}
],
"settings": {
"datasourceId": "<string>",
"assignmentQueryId": "<string>",
"experimentId": "<string>",
"segmentId": "<string>",
"queryFilter": "<string>",
"inProgressConversions": "include",
"attributionModel": "firstExposure",
"statsEngine": "bayesian",
"goals": [
{
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"window": "conversion",
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
],
"secondaryMetrics": [
{
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"window": "conversion",
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
],
"guardrails": [
{
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"window": "conversion",
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
],
"lookbackOverride": {
"type": "date",
"value": 123,
"valueUnit": "minutes"
},
"regressionAdjustmentEnabled": true,
"sequentialTestingEnabled": true,
"sequentialTestingTuningParameter": 123,
"postStratificationEnabled": true,
"decisionFrameworkSettings": {
"decisionCriteriaId": "<string>",
"decisionFrameworkMetricOverrides": [
{
"id": "<string>",
"targetMDE": 123
}
]
},
"metricOverrides": [
{
"id": "<string>",
"windowType": "conversion",
"windowHours": 123,
"delayHours": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
],
"activationMetric": {
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"window": "conversion",
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
},
"ownerEmail": "<string>",
"fallbackAttribute": "<string>",
"disableStickyBucketing": true,
"bucketVersion": 123,
"minBucketVersion": 123,
"resultSummary": {
"status": "<string>",
"winner": "<string>",
"conclusions": "<string>",
"releasedVariationId": "<string>",
"excludeFromPayload": true
},
"shareLevel": "public",
"publicUrl": "<string>",
"banditScheduleValue": 123,
"banditScheduleUnit": "days",
"banditBurnInValue": 123,
"banditBurnInUnit": "days",
"banditConversionWindowValue": 123,
"banditConversionWindowUnit": "days",
"linkedFeatures": [
"<string>"
],
"attributeScopeAllProjects": true,
"hasVisualChangesets": true,
"hasURLRedirects": true,
"customFields": {},
"customMetricSlices": [
{
"slices": [
{
"column": "<string>",
"levels": [
"<string>"
]
}
]
}
],
"precomputedUnitDimensionIds": [
"<string>"
],
"defaultDashboardId": "<string>",
"templateId": "<string>",
"statusUpdateSchedule": {
"startAt": "2023-11-07T05:31:56Z",
"stopAt": "2023-11-07T05:31:56Z",
"stopAfter": {
"value": 123,
"unit": "hours"
},
"scheduledStopPlan": {
"mode": "notify",
"tiebreakerMetricId": "<string>",
"fallback": "notify",
"fallbackVariationId": "<string>"
}
},
"nextScheduledStatusUpdate": {
"type": "start",
"date": "2023-11-07T05:31:56Z"
},
"enhancedStatus": {
"status": "Running",
"detailedStatus": "<string>"
}
},
"warnings": [
"<string>"
]
}{
"message": "<string>",
"code": "invalid_status",
"details": {
"currentStatus": "<string>",
"expectedStatuses": [
"<string>"
]
}
}