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
duplicate_issue_id Integer No

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.

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.

Valid values:

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

The title of the issue.

body String No

The contents of the issue.

issue_field_values[] Array No

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

issue_field_values[].confidence String No

The confidence level for this field value choice.

Valid values:

  • "medium"
  • "low"
  • "high"
issue_field_values[].field_id Integer Yes

The ID of the issue field to set

issue_field_values[].rationale String No

Optional reasoning for setting this field value.

issue_field_values[].suggest Boolean No

If true, the change is stored as a pending suggestion for human review rather than applied directly.

issue_field_values[].value Yes

The value to set for the field. For multi-select fields, provide an array of option names.

type No

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.

state String No

The open or closed state of the issue.

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