octokit.rest

Merge a pull request

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

Parameters

string The token will be passed in the authorization header.

string

string

integer

string Title for the automatic commit message.

string Extra detail to append to automatic commit message.

string SHA that pull request head must match to allow merge.

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

Request

PUT https://api.github.com/repos///pulls//merge
authorization: bearer undefined
accept: application/vnd.github.v3+json
user-agent: octokit.rest
content-length: 0

Example Response

Status: 200
{
  "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
  "merged": true,
  "message": "Pull Request successfully merged"
}

See documentation on GitHub developer guides