Sign in
pulls

Merge a pull request asynchronously

Merges a pull request into the base branch in the background or adds it to a merge queue. Background processing allows certain types of errors to be retried and reduces the risk of timeouts for complex merges.

This is the required API for merging stacked pull requests. For a stacked pull request, the operation includes all open downstack pull requests.

A new asynchronous merge request returns a 202 response with a UUID that can be used to fetch the result of the merge. If another asynchronous merge request is already pending for this pull request, a 409 response returns that request's UUID and merge options instead.

If the pull request is already merged or already in a merge queue, a 200 response is returned immediately. A merged result includes the merge commit OID. An enqueued result means the pull request was added to the merge queue, not that it has merged.

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. Only supported for direct merges.

commit_messagestring

Extra detail to append to automatic commit message. Only supported for direct merges.

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 for a direct merge. Only supported for direct merges.

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 uses a merge queue if one is configured for the target branch, or merges directly otherwise. If omitted, defaults to default.

Response

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

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

Changes