Merge a pull request

POST

/repos/{owner}/{repo}/pulls/{index}/merge

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

index

required

integer format: int64

Index of the pull request to merge

Request Body

MergePullRequestForm form for merging Pull Request

object

Do

required

string

Allowed values: merge rebase rebase-merge squash fast-forward-only manually-merged

MergeCommitID

string

MergeMessageField

string

MergeTitleField

string

delete_branch_after_merge

boolean

force_merge

boolean

head_commit_id

string

merge_when_checks_succeed

boolean

MergePullRequestForm form for merging Pull Request

object

Do

required

string

Allowed values: merge rebase rebase-merge squash fast-forward-only manually-merged

MergeCommitID

string

MergeMessageField

string

MergeTitleField

string

delete_branch_after_merge

boolean

force_merge

boolean

head_commit_id

string

merge_when_checks_succeed

boolean

Responses

200

APIEmpty is an empty response

Media type application/json

404

APINotFound is a not found error response

Media type application/json

object

errors

Array<string>

message

string

url

string

Example ^generated

{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}

405

APIEmpty is an empty response

Media type application/json

409

APIError is error format response

Media type application/json

APIError is an api error with a message

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}

413

QuotaExceeded

Media type application/json

Headers

message

string

user_id

integer format: int64

username

string

423

APIRepoArchivedError is an error that is raised when an archived repo should be modified

Media type application/json

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}