Shipeasy
APIOperations

Approve a change

Approve a change at its latest push — what the Human review gate counts. Approving the same push twice is a no-op. When the project's gates reset approvals…

Approve a change at its latest push — what the Human review gate counts. Approving the same push twice is a no-op. When the project's gates reset approvals on push, a later push needs a fresh approval. Unless the gates allow authorCanApprove, the trail's owner and whoever started its runs do not count.

Approval is a person's call. Only a dashboard session or a device-auth CLI session can approve — ops keys, project admin keys and OAuth MCP calls are refused with 403. This operation is not exposed as an MCP tool.

Use case

A reviewer has read the evals and the diff and signs off.

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

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/approve" \  -H "Content-Type: application/json" \  -d '{    "body": "Read the diff and the security eval, looks good"  }'
{
  "id": "string",
  "actorEmail": "string",
  "body": "string",
  "headSha": "string",
  "current": true,
  "actorKind": "person",
  "authorizedBy": "string",
  "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": "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?