Shipeasy
APIOperations

Change a milestone

Rename a milestone, change its description or target date, or move it in the trail's order with position (the others shift to make room). Pass at least one…

Rename a milestone, change its description or target date, or move it in the trail's order with position (the others shift to make room). Pass at least one field; the rest are left as they are.

Safe for the restricted ops key.

Use case

The second stage slipped a week; move its target date so the trail's health reads it correctly.

PATCH
/api/admin/trails/{handle}/milestones/{milestoneId}

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

handle*string

The trail's handle (T-12) or its id.

Match^(?:T-[0-9]+|[0-9a-fA-F-]{32,36})$
Length1 <= length <= 64
milestoneId*string

The milestone's id (TrailMilestone.id).

Match^[0-9a-fA-F-]{32,36}$
Length1 <= length <= 64

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

curl -X PATCH "https://shipeasy.ai/api/admin/trails/string/milestones/string" \  -H "Content-Type: application/json" \  -d '{    "targetDate": "2026-12-04"  }'
{
  "id": "string",
  "name": "string",
  "description": "string",
  "targetDate": "2019-08-24",
  "position": 0,
  "itemsTotal": 0,
  "itemsDone": 0,
  "late": true
}
{
  "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": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?