Skip to main content
POST
Merge a pull request when green

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

provider
enum<string>
required
Available options:
github,
gitlab,
bitbucket_cloud
owner
string
required

Repository owner or workspace.

repo
string
required

Repository name.

number
integer
required

Pull request number.

Required range: x >= 1

Body

application/json
head_sha
string
required

The head commit the merge is for; a newer push voids the request.

Response

The request was accepted

A request to merge a pull request once its checks are green.

id
string
required
organisation_id
string
required
provider
string
required
repo_owner
string
required
repo_name
string
required
pull_request_number
integer
required
head_sha
string
required
requested_by
string
required
requested_via
string
required
status
string
required
refusal_reason
string
required
expires_at
string<date-time>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
merge_commit_sha
string

Present once merged.

merged_at
string<date-time>

Present once merged.