Shipeasy
APIOperations

Merge a change

Merge a change's pull request on GitHub at the head its gates were evaluated on. Refused with 409 while a blocking gate has not passed, unless bypass is set…

Merge a change's pull request on GitHub at the head its gates were evaluated on. Refused with 409 while a blocking gate has not passed, unless bypass is set with a reason — bypass needs the bypass capability, and is audited and posted on the trail. GitHub's own branch rules can still refuse the merge (502). Merging one change never merges the trail's other changes; when the last open change merges the trail moves to releasing.

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

Use case

Every gate is green; merge from the trail instead of switching to GitHub.

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

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

application/json

curl -X POST "https://shipeasy.ai/api/admin/trails/string/merge" \  -H "Content-Type: application/json" \  -d '{    "method": "squash"  }'
{
  "prUrl": "string",
  "merged": true,
  "sha": "string",
  "bypassed": [
    "up_to_date"
  ]
}
{
  "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"
}

{
  "error": "GitHub API responded 403: resource not accessible by integration."
}
Was this page helpful?