Skip to main content
Manja / GitHub

Merge a pull request

This endpoint triggers [notifications](https://docs.github.com/[email protected]/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/[email protected]/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.

PUT/repos/{owner}/{repo}/pulls/{pull_number}/merge
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
owner string
required
repo string
required
pull_number integer
required
Body Params
optional
application/jsonobject
commit_message string
optional

Extra detail to append to automatic commit message.

commit_title string
optional

Title for the automatic commit message.

merge_method string
optional

Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.

Allowed: "merge""squash""rebase"

sha string
optional

SHA that pull request head must match to allow merge.

Responses

application/json Pull Request Merge Result object

if merge was successful

merged boolean
required
message string
required
sha string
required
application/json Basic Error object

Forbidden

documentation_url string
optional
message string
optional
status string
optional
url string
optional
application/json Basic Error object

Resource not found

documentation_url string
optional
message string
optional
status string
optional
url string
optional
application/json object

Method Not Allowed if merge cannot be performed

documentation_url string
optional
message string
optional
application/json object

Conflict if sha was provided and pull request head did not match

documentation_url string
optional
message string
optional
application/json Validation Error object

Validation failed

documentation_url string
required
errors array[object]
optional
items object
code string
required
field string
optional
index integer
optional
message string
optional
resource string
optional
value
optional
message string
required