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

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.

Servers

https://api.github.com

Path parameters

Name	Type	Required	Description
`repo`	String	Yes	The name of the repository without the `.git` extension. The name is not case sensitive.
`owner`	String	Yes	The account owner of the repository. The name is not case sensitive.
`pull_number`	Integer	Yes	The number that identifies the pull request.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`commit_message`	String	No	Extra detail to append to automatic commit message.
`sha`	String	No	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_action`	String	No	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. Valid values: `"merge_queue"` `"direct_merge"` `"default"`
`commit_title`	String	No	Title for the automatic commit message.
`merge_method`	String	No	The merge method to use. Valid values: `"merge"` `"rebase"` `"squash"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.