Update issue with the GitHub API

Changes an issue and returns it. Only the fields sent change. To close it, send state closed with a state_reason. Labels and assignees replace the current ones, and an empty list clears them.

Identifier
github_update_issue

The request

POST https://connect.reportei.com/api/tools/github_update_issue/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>",
    "issue_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.
issue_numberintegerYesNumber of the issue, the number of List issues or Search issues.
titlestringNoNew title.
bodystringNoNew content, in Markdown.
statestringNoCloses or reopens the issue.Values: open, closed
state_reasonstringNoWhy the state changed. Ignored unless state changes.Values: completed, not_planned, duplicate, reopened
duplicate_issue_idintegerNoWith state_reason duplicate, the id (not the number) of the issue this one duplicates, from the id field of List issues or Get issue.
labelsarrayNoNames of the labels the issue should have, replacing the current ones. An empty list removes all.
assigneesarrayNoLogins of the users the issue should be assigned to, replacing the current ones. An empty list removes all.
milestoneintegerNoNumber of a milestone of the repository, from the milestone.number of an issue in List issues.
typestringNoName of an issue type of the organization, such as Bug or Task.

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