GitHub: Merge a pull request asynchronously

GitHub pulls.pullsMergeAsync: arguments, response, policy and SDK examples.

Operation github.pulls_merge_async

Provider route: PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge-async. 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"]["pullsMergeAsync"]>[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.pullsMergeAsync(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_async(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).bypass_rules`	boolean	Optional	Whether to bypass repository rules that the authenticated actor is permitted to bypass. Default: false
`body (anyOf 1).commit_message`	string	Optional	Extra detail to append to automatic commit message. Only supported for direct merges.
`body (anyOf 1).commit_title`	string	Optional	Title for the automatic commit message. Only supported for direct merges.
`body (anyOf 1).merge_action`	string	Optional	The action that will be taken to merge the pull request. `direct_merge` merges the pull request directly without using a merge queue; `merge_queue` adds the pull request to a merge queue; `default` uses a merge queue if one is configured for the target branch, or merges directly otherwise. If omitted, defaults to `default`. One of: default, direct_merge, merge_queue
`body (anyOf 1).merge_method`	string	Optional	The merge method to use for a direct merge. Only supported for direct merges. One of: merge, squash, rebase
`body (anyOf 1).sha`	string	Optional	SHA that pull request head must match to allow merge. If not provided, the current head of the PR at the time of the request will be used; if the PR is pushed in between the merge being requested and being executed, the merge will be cancelled.
`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
`$`	JSON	Root
`$ (anyOf 1)`	Model	Alternative	Expand Get the result of an asynchronous merge — response body
`$ (anyOf 2)`	Model	Alternative	Expand Get the result of an asynchronous merge — response body

Referenced models: Get the result of an asynchronous merge — response body

Schemas

Get the result of an asynchronous merge — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Pull Request Merge Async Result Additional keys: not allowed
`details`	JSON	Required within parent
`details (anyOf 1)`	object	Alternative	When the asynchronous merge request is pending Additional keys: not allowed
`details (anyOf 1).bypass_rules`	boolean	Optional	Whether the asynchronous merge request will attempt to bypass repository rules that the authenticated actor is permitted to bypass. Default: false
`details (anyOf 1).expected_head_sha`	string	Required within parent	SHA that the pull request head must match for the enqueued merge to proceed.
`details (anyOf 1).merge_action`	string	Required within parent	Known values: default, merge_queue, direct_merge
`details (anyOf 1).merge_method`	string	Required within parent	Known values: default, merge, squash, rebase
`details (anyOf 1).message`	string	Required within parent
`details (anyOf 1).uuid`	string	Required within parent
`details (anyOf 2)`	object	Alternative	When the pull request is in a merge queue Additional keys: not allowed
`details (anyOf 2).message`	string	Required within parent
`details (anyOf 3)`	object	Alternative	When the asynchronous merge request failed Additional keys: not allowed
`details (anyOf 3).message`	string	Required within parent
`details (anyOf 4)`	object	Alternative	When the pull request has been merged Additional keys: not allowed
`details (anyOf 4).message`	string	Required within parent
`details (anyOf 4).sha`	string	Required within parent
`status`	string	Required within parent	Known values: pending, merged, enqueued, failed

Policy, approvals and errors

SDK function policy ID: github.pulls_merge_async. Catalog operation: pulls/merge-async. 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

Report an issue with this page