Merge pull request with the GitHub API

Merges a pull request into its base branch and returns merged and the sha of the new commit. Answers 405 when the pull request cannot be merged, and 409 when sha no longer matches its head. Repositories that merge through a merge queue do not accept it.

Identifier
github_merge_pull_request

The request

POST https://connect.reportei.com/api/tools/github_merge_pull_request/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "owner": "<owner>",
    "repo": "<repo>",
    "pull_number": 1
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
ownerstringYesLogin of the user or organization that owns the repository, the owner.login of List repositories.
repostringYesName of the repository, the name of List repositories.
pull_numberintegerYesNumber of the pull request, the number of List pull requests or Search issues.
merge_methodstringNoHow to merge. The default is merge; the repository may allow only some methods.Values: merge, squash, rebase
commit_titlestringNoTitle of the merge commit.
commit_messagestringNoExtra text for the merge commit message.
shastringNoThe head.sha of Get pull request. The merge only happens if the branch still points to it.

Supported connections

Your customer connects their GitHub account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/github, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/github_merge_pull_request. It becomes your agent's tool definition with no conversion.

Other GitHub tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.