v69

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-051,22096912.3 MB

pulls

Merge a pull request asynchronously

Merges a pull request into the base branch in the background. Merging in this way allows certain types of errors to be retried, and avoids the risk of timeouts for particularly complex merges.

This is the required method for merging stacked PRs, but also supports unstacked PRs. When using this endpoint to merge a stacked pull request, all pull requests in the stack up to and including the requested PR will be merged into the base branch.

The response includes a UUID that can be used to fetch the result of the merge. If another asynchronous merge request has already been made for this pull request, the UUID of that request will be returned instead with a 409 response status to indicate that the merge options may be different from those that were requested. If there isn't an existing asynchronous merge request, a 202 response status is used.

If the pull request is already merged, the merge commit OID will be returned immediately with a 200 status.

If the pull request cannot be merged (e.g. because it is closed, or still a draft) this result will be returned immediately with a 400 response status. Branch protection rules and repository rules are not run at this stage, only basic pull request state checks are performed.

put/repos/{owner}/{repo}/pulls/{pull_number}/merge-async

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

pull_numberinteger required

The number that identifies the pull request.

Request body

commit_titlestring

Title for the automatic commit message.

commit_messagestring

Extra detail to append to automatic commit message.

shastring

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.

merge_method'merge' | 'squash' | 'rebase'

The merge method to use.

merge_action'default' | 'direct_merge' | 'merge_queue'

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 selects the most appropriate option.

Response

if the pull request was already merged, or is already in a merge queue

status'pending' | 'merged' | 'enqueued' | 'failed' required