GitHub: Merge a pull request

← Pulls operations · Get started

Operation github.pulls_merge

Provider route: PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["pulls"]["pullsMerge"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.pulls.pullsMerge(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.pulls.pulls_merge(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent
path.pull_number	integer	Required within parent
body	JSON	Optional
body (anyOf 1)	object	Alternative
body (anyOf 1).commit_message	string	Optional	Extra detail to append to automatic commit message.
body (anyOf 1).commit_title	string	Optional	Title for the automatic commit message.
body (anyOf 1).merge_method	string	Optional	The merge method to use. One of: merge, squash, rebase
body (anyOf 1).sha	string	Optional	SHA that pull request head must match to allow merge.
body (anyOf 2)	null	Alternative

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Merge a pull request — response body

Referenced models: Merge a pull request — response body

Schemas

Merge a pull request — response body

Field	Type	Presence	Description and constraints
$	object	Root	Pull Request Merge Result
merged	boolean	Required within parent
message	string	Required within parent
sha	string	Required within parent

Policy, approvals and errors

SDK function policy ID: github.pulls_merge. Catalog operation: pulls/merge. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source