Shipeasy
Flags experimentsApiOperations

Update the current project

Update the current project's settings — name, domain, slug, default environment, timezone, experiment-analysis knobs (statistical method, significance…

Update the current project's settings — name, domain, slug, default environment, timezone, experiment-analysis knobs (statistical method, significance threshold, auto-rollback, minimum sample days), and the per-module enable flags. Partial: only the fields you send change.

The project id in the path must match the project the caller's credential resolves to (a credential can only edit its own project). Changing domain re-stamps the allowed origin into every live SDK key.

Use case

Rename a project, move its domain, toggle a module on/off, or tune the experiment-analysis defaults without leaving the CLI.

PATCH
/api/admin/projects/{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 project id. Must match the caller's own project.

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

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/projects/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Acme Rockets"  }'
{
  "id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "name": "Acme Rockets",
  "domain": "acme.com",
  "ownerEmail": "owner@acme.com",
  "plan": "pro",
  "status": "active",
  "subscriptionStatus": "active",
  "billingInterval": "monthly",
  "currentPeriodEnd": "2026-07-12T00:00:00.000Z",
  "trialEndsAt": null,
  "cancelAtPeriodEnd": 0,
  "moduleTranslations": true,
  "moduleConfigs": true,
  "moduleGates": true,
  "moduleExperiments": false,
  "moduleFeedback": true,
  "createdAt": "2026-04-12T10:14:08.000Z",
  "updatedAt": "2026-06-12T08:01:55.000Z"
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?
✎ Edit this page