Update a ramp schedule

Updates the name, steps, endActions, startDate, or endCondition of a ramp schedule.

Only allowed when the schedule is in pending, ready, or paused status.

targetId shorthand: When providing steps or endActions, you may omit targetId (or pass "t1") in each action. If the schedule has exactly one active target, the server will resolve it automatically. For schedules with multiple targets, provide the explicit target UUID from targets[].id.

PUT /ramp-schedules/{id}

cURL

cURL

curl -X PUT https://api.growthbook.io/api/v1/ramp-schedules/rs_abc123 \
  -d '{ "name": "Updated ramp" }' \
  -u secret_abc123DEF456:

200

{
  "rampSchedule": {
    "id": "<string>",
    "organization": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "entityType": "feature",
    "entityId": "<string>",
    "targets": [
      {
        "id": "<string>",
        "entityType": "feature",
        "entityId": "<string>",
        "status": "pending-join",
        "ruleId": "<string>",
        "environment": "<string>",
        "activatingRevisionVersion": 123
      }
    ],
    "steps": [
      {
        "trigger": {
          "type": "interval",
          "seconds": 123,
          "at": "2023-11-07T05:31:56Z"
        },
        "actions": [
          {
            "targetType": "feature-rule",
            "targetId": "<string>",
            "patch": {
              "ruleId": "<string>",
              "coverage": 0.5,
              "condition": "<string>",
              "force": "<unknown>"
            }
          }
        ],
        "approvalNotes": "<string>"
      }
    ],
    "status": "pending",
    "currentStepIndex": 0,
    "nextStepAt": "2023-11-07T05:31:56Z",
    "endActions": [
      {
        "targetType": "feature-rule",
        "targetId": "<string>",
        "patch": {
          "ruleId": "<string>",
          "coverage": 0.5,
          "condition": "<string>",
          "force": "<unknown>"
        }
      }
    ],
    "startDate": "2023-11-07T05:31:56Z",
    "endCondition": {
      "trigger": {
        "type": "scheduled",
        "at": "2023-11-07T05:31:56Z"
      }
    },
    "startedAt": "2023-11-07T05:31:56Z",
    "phaseStartedAt": "2023-11-07T05:31:56Z",
    "pausedAt": "2023-11-07T05:31:56Z",
    "elapsedMs": 123
  }
}

Authorizations

bearerAuthbasicAuth

Authorization · string · header · required

If using Bearer auth, pass the Secret Key as the token:

curl https://api.growthbook.io/api/v1 \
  -H "Authorization: Bearer secret_abc123DEF456"

Path Parameters

id · string · required

The id of the requested resource

Body

application/json

name · string

steps · object[]

Show child attributes

endActions · object[]

Show child attributes

startDate · string<date-time> | null

endCondition · object

Show child attributes

Response

200 - application/json

Success

rampSchedule · object · required

Show child attributes