Shipeasy
APIOperations

Add a QA note to an item

Append one typed QA note to a queue item. kind is narrowing (what now passes vs what still fails), clarification (what "fixed" now means), what was checked)…

Append one typed QA note to a queue item. kind is narrowing (what now passes vs what still fails), clarification (what "fixed" now means), what was checked) or correction (withdraws an earlier framing). Notes are append-only and appear in the item's QA notes section, not in the comment thread. The author is the caller's identity; pass agent to record the note as written by that agent type's QA automation. status by itself: the dashboard offers an explicit "Reopen item" action, and ops update --status open does the same from the CLI.

Use case

QA automation records "verified on production: FAIL, the second facet still errors" as data an agent can read back.

POST
/api/admin/ops/{handle}/qa-notes

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

Per-project item number (e.g. 7) or the full ops item id.

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

curl -X POST "https://shipeasy.ai/api/admin/ops/string/qa-notes" \  -H "Content-Type: application/json" \  -d '{    "kind": "verification",    "body": "Retested on production after the deploy — the export still drops the second sheet"  }'
{
  "id": "string",
  "feedbackId": "string",
  "kind": "narrowing",
  "body": "string",
  "authorEmail": "string",
  "authorAgent": "jarvis",
  "createdAt": "string"
}
{
  "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?