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."
application/vnd.github.raw+json: Returns the raw markdown body. Response will includebody. This is the default if you do not pass any specific media type.application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will includebody_text.application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will includebody_html.application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will includebody,body_text, andbody_html.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
repo |
String | Yes |
The name of the repository without the |
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 ( |
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 ( |
state_reason |
String | No |
The reason for the state change. Ignored unless Valid values:
|
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[].field_id |
Integer | Yes |
The ID of the issue field to set |
issue_field_values[].value |
Yes |
The value to set for the field |
|
type |
String | No |
The name of the issue type to associate with this issue or use |
state |
String | No |
The open or closed state of the issue. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.