Shipeasy
APIOperations

Move an item to a milestone

Move an item on the trail into a milestone, or out of every milestone with milestoneId: null. The item stays on the trail and keeps its discovery record;…

Move an item on the trail into a milestone, or out of every milestone with milestoneId: null. The item stays on the trail and keeps its discovery record; only the milestone it counts toward changes. An item that is not on the trail is 404, and so is a milestone of another trail.

Safe for the restricted ops key.

Use case

A bug filed on the trail turns out to block the first milestone; move it there so the build works it with the rest of that milestone.

PATCH
/api/admin/trails/{handle}/items/{itemHandle}

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
itemHandle*string

The queue item's per-project number (e.g. 42) or its full id.

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/items/string" \  -H "Content-Type: application/json" \  -d '{    "milestoneId": "3b1f0c9e-7d42-4a8e-9f61-2c5d8e4a7b90"  }'
{
  "ok": 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?