Shipeasy
APIOperations

Put an existing item on a trail

Attach an existing queue item to the trail, recorded with source attached, optionally into a milestone (milestoneId). An item is on at most one trail; one…

Attach an existing queue item to the trail, recorded with source attached, optionally into a milestone (milestoneId). An item is on at most one trail; one already on another trail is refused with 409. To file a new item on a trail, use ops bug --trail or ops feature --trail.

Safe for the restricted ops key.

Use case

A bug already in the queue turns out to be part of the work; attach it so the trail tracks it.

POST
/api/admin/trails/{handle}/items

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

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 POST "https://shipeasy.ai/api/admin/trails/string/items" \  -H "Content-Type: application/json" \  -d '{    "item": "42"  }'
{
  "item": {
    "id": "string",
    "number": 0,
    "type": "bug",
    "title": "string",
    "status": "open"
  },
  "priority": "nice_to_have",
  "discoveredSource": "origin",
  "discoveredSha": "string",
  "change": {
    "id": "string",
    "prUrl": "string",
    "prNumber": 0,
    "repo": "string"
  },
  "milestoneId": "string",
  "workKind": "code"
}
{
  "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?