PUT

Try PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge-async — GitHub API

GitHub playground

Merge a pull request asynchronously

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

owner · required · string The account owner of the repository. The name is not case sensitive. repo · required · string The name of the repository without the `.git` extension. The name is not case sensitive. pull_number · required · integer The number that identifies the pull request.

Body application/json

6 body fields

commit_title · optional · string — Title for the automatic commit message. Only supported for direct merges.
commit_message · optional · string — Extra detail to append to automatic commit message. Only supported for direct merges.
sha · optional · string — 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 · optional · string — The merge method to use for a direct merge. Only supported for direct merges.
merge_action · optional · string — 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`.
bypass_rules · optional · boolean — Whether to bypass repository rules that the authenticated actor is permitted to bypass.