Create pull request with the GitHub API

Opens a pull request from the head branch into the base branch and returns it, with its number. Send title, or issue to turn an existing issue into the pull request. Notifies the watchers of the repository.

Identifier
github_create_pull_request

The request

POST https://connect.reportei.com/api/tools/github_create_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>",
    "head": "<head>",
    "base": "<base>"
  }
}

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.
headstringYesBranch with the changes. For a branch of a fork, write owner:branch.
basestringYesExisting branch of this repository that receives the changes, such as main.
titlestringNoTitle of the pull request. Required unless issue is sent.
bodystringNoDescription of the pull request, in Markdown.
draftbooleanNoOpens it as a draft. In private repositories, drafts need GitHub Team or Enterprise Cloud.
maintainer_can_modifybooleanNoLets the maintainers of the base repository push to the head branch of a fork.
issueintegerNoNumber of an issue of the repository, the number of List issues, to turn into this pull request. Its title, body and comments move to the pull request.

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_create_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.