PATCH /repos/{owner}/{repo}/issues/{issue_number}

Issue owners and users with push access or Triage role can edit an issue.

This endpoint supports the following custom media types. For more information, see "Media types."

Servers

Path parameters

Name Type Required Description
repo String Yes

The name of the repository without the .git extension. The name is not case sensitive.

issue_number Integer Yes

The number that identifies the issue.

owner String Yes

The account owner of the repository. The name is not case sensitive.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
assignee String No

Username to assign to this issue. This field is closing down.

milestone No
labels[] Array No

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[] Array No

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.

state_reason String No

The reason for the state change. Ignored unless state is changed.

Possible values:

  • "not_planned"
  • "reopened"
  • "completed"
title No

The title of the issue.

body String No

The contents of the issue.

type String No

The name of the issue type to associate with this issue or use null to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.

state String No

The open or closed state of the issue.

Possible values:

  • "open"
  • "closed"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.