Update a review comment for a pull request

Enables you to edit a review comment.

PATCH/repos/{owner}/{repo}/pulls/comments/{comment_id}

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

owner string required
repo string required
comment_id integer required: comment_id parameter

Body Params

required

application/jsonobject

body string

required

The text of the reply to the review comment.

Responses

application/json Pull Request Review Comment object

Response

_links object

required

html object

required

href string<uri>

required

Example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1

pull_request object

required

href string<uri>

required

Example: https://api.github.com/repos/octocat/Hello-World/pulls/1

self object

required

href string<uri>

required

Example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1

author_association

string< author_association >

required

How the author is associated with the repository.

Example: OWNER

Allowed: "COLLABORATOR""CONTRIBUTOR""FIRST_TIMER""FIRST_TIME_CONTRIBUTOR""MANNEQUIN""MEMBER""NONE""OWNER"

body string

required

The text of the comment.

Example: We should probably include a check for null values here.

body_html string

optional

Example: "<p>comment body</p>"

body_text string

optional

Example: "comment body"

commit_id string

required

The SHA of the commit to which the comment applies.

Example: 6dcb09b5b57875f334f61aebed695e2e4193db5e

created_at string<date-time>

required

Example: 2011-04-14T16:00:49Z

diff_hunk string

required

The diff of the line that the comment refers to.

Example: @@ -16,33 +16,40 @@ public class Connection : IConnection...

html_url string<uri>

required

HTML URL for the pull request review comment.

Example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1

id integer

required

The ID of the pull request review comment.

Example: 1

in_reply_to_id integer

optional

The comment ID to reply to.

Example: 8

line integer

optional

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

Example: 2

node_id string

required

The node ID of the pull request review comment.

Example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw

original_commit_id string

required

The SHA of the original commit to which the comment applies.

Example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840

original_line integer

optional

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

Example: 2

original_position integer

required

The index of the original line in the diff to which the comment applies.

Example: 4

original_start_line integer

optionalnullable

The first line of the range for a multi-line comment.

Example: 2

path string

required

The relative path of the file to which the comment applies.

Example: config/database.yaml

position integer

required

The line index in the diff to which the comment applies.

Example: 1

pull_request_review_id integer

requirednullable

The ID of the pull request review to which the comment belongs.

Example: 42

pull_request_url string<uri>

required

URL for the pull request that the review comment belongs to.

Example: https://api.github.com/repos/octocat/Hello-World/pulls/1

reactions Reaction Rollup object

optional

+1 integer

required

-1 integer

required

confused integer

required

eyes integer

required

heart integer

required

hooray integer

required

laugh integer

required

rocket integer

required

total_count integer

required

url string<uri>

required

side string

optional

The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment

Default: RIGHT

Allowed: "LEFT""RIGHT"

start_line integer

optionalnullable

The first line of the range for a multi-line comment.

Example: 2

start_side string

optionalnullable

The side of the first line of the range for a multi-line comment.

Default: RIGHT

Allowed: "LEFT""RIGHT"

updated_at string<date-time>

required

Example: 2011-04-14T16:00:49Z

url string

required

URL for the pull request review comment

Example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1

user Simple User object

required

Simple User

avatar_url string<uri>

required

Example: https://github.com/images/error/octocat_happy.gif

email string

optionalnullable

events_url string

required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>

required

Example: https://api.github.com/users/octocat/followers

following_url string

required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string

required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string

requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>

required

Example: https://github.com/octocat

id integer

required

Example: 1

required

Example: octocat

name string

optionalnullable

node_id string

required

Example: MDQ6VXNlcjE=

organizations_url string<uri>

required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>

required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>

required

Example: https://api.github.com/users/octocat/repos

site_admin boolean

required

starred_at string

optional

Example: "2020-07-09T00:17:55Z"

starred_url string

required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>

required

Example: https://api.github.com/users/octocat/subscriptions

type string

required

Example: User

url string<uri>

required

Example: https://api.github.com/users/octocat

Response Example: 200 application/json

{
  "_links": {
    "html": {
      "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1"
    },
    "pull_request": {
      "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
    },
    "self": {
      "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1"
    }
  },
  "author_association": "NONE",
  "body": "Great stuff!",
  "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
  "created_at": "2011-04-14T16:00:49Z",
  "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...",
  "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1",
  "id": 10,
  "in_reply_to_id": 8,
  "line": 2,
  "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw",
  "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840",
  "original_line": 2,
  "original_position": 4,
  "original_start_line": 1,
  "path": "file1.txt",
  "position": 1,
  "pull_request_review_id": 42,
  "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1",
  "side": "RIGHT",
  "start_line": 1,
  "start_side": "RIGHT",
  "updated_at": "2011-04-14T16:00:49Z",
  "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
  "user": {
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "gravatar_id": "",
    "html_url": "https://github.com/octocat",
    "id": 1,
    "login": "octocat",
    "node_id": "MDQ6VXNlcjE=",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "site_admin": false,
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "type": "User",
    "url": "https://api.github.com/users/octocat"
  }
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

owner *

repo *

comment_id *

comment_id parameter

Request Sample: Shell / cURL

curl --request PATCH \
  --url {protocol}://{hostname}/api/v3/repos/{owner}/{repo}/pulls/comments/{comment_id} \
  --header 'content-type: application/json' \
  --data '{
  "body": "I like this too!"
}'