Shipeasy
Flags experimentsApiOperations

Update an experiment

Partial update. allocation_pct, groups, salt, universe, params are immutable while running — returns 409 if you try. Stop the experiment first.

Editing groups while in draft is fine; weights must still sum to 10000.

Use cases
  • Update metadata — description, tag, targeting_gate editable any time.
  • Ramp before launch — set allocation_pct while still in draft.
  • Tighten significance — significance_threshold (Pro+).
  • Rewire groups — replace groups wholesale while in draft; immutable once running.
PATCH
/api/admin/experiments/{id}

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

id*string

Stable opaque experiment id.

Header Parameters

X-Project-Id*string

Project the request operates on. Must match the project the SDK key belongs to.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://shipeasy.ai/api/admin/experiments/string" \  -H "X-Project-Id: string" \  -H "Content-Type: application/json" \  -d '{    "allocation_pct": 5000  }'
{
  "id": "exp_01j7wb12c3d4e5f6g7h8j9k0l1"
}
{
  "error": "string",
  "code": "string",
  "detail": "string"
}
{
  "error": "string",
  "code": "string",
  "detail": "string"
}
{
  "error": "string",
  "code": "string",
  "detail": "string"
}
{
  "error": "string",
  "code": "string",
  "detail": "string"
}
{
  "error": "string",
  "code": "string",
  "detail": "string"
}
{
  "error": "string",
  "code": "string",
  "detail": "string"
}