PATCH

Try PATCH /repos/{owner}/{repo}/issues/{issue_number} — GitHub API

GitHub playground

Update an issue

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

owner · required · string The account owner of the repository. The name is not case sensitive. repo · required · string The name of the repository without the `.git` extension. The name is not case sensitive. issue_number · required · integer The number that identifies the issue.

Body application/json

10 body fields

title · optional · string — The title of the issue.
body · optional · string — The contents of the issue.
state · optional · string — The open or closed state of the issue.
state_reason · optional · string — The reason for the state change. Ignored unless `state` is changed.
duplicate_issue_id · optional · integer — The ID of the issue to mark as the canonical duplicate when `state_reason` is `duplicate`. The issue must exist and be accessible to the authenticated user. Ignored when `state_reason` is not `duplicate`.
milestone · optional · string — Request body field milestone.
labels · optional · string[] — Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.
assignees · optional · string[] — Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.
issue_field_values · optional · object[] — An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Only users with push access can set field values for issues
type · optional · string — The issue type to associate with this issue. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.