Create a review comment for a pull request

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "Create an issue comment." We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

Note: The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.

curl --location --request POST 'https://api.github.com/repos///pulls//comments' \ --header 'Content-Type: application/json' \ --data-raw '{ "body": "Great stuff!", "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "line": 2, "path": "file1.txt", "side": "RIGHT", "start_line": 1, "start_side": "RIGHT" }'

{ "_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": "OWNER", "body": "We should probably include a check for null values here.", "body_html": "\"<p>comment body</p>\"", "body_text": "\"comment body\"", "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", "created_at": "2011-04-14T16:00:49.000Z", "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", "id": 1, "in_reply_to_id": 8, "line": 2, "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", "original_line": 2, "original_position": 4, "original_start_line": 2, "path": "config/database.yaml", "position": 1, "pull_request_review_id": 42, "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", "reactions": { "+1": 0, "-1": 0, "confused": 0, "eyes": 0, "heart": 0, "hooray": 0, "laugh": 0, "rocket": 0, "total_count": 0, "url": "http://example.com" }, "side": "RIGHT", "start_line": 2, "start_side": "RIGHT", "updated_at": "2011-04-14T16:00:49.000Z", "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", "user": { "avatar_url": "https://github.com/images/error/octocat_happy.gif", "email": "string", "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": "41d064eb2195891e12d0413f63227ea7", "html_url": "https://github.com/octocat", "id": 1, "login": "octocat", "name": "string", "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": true, "starred_at": "\"2020-07-09T00:17:55Z\"", "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

Path Params

owner

string

required

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

repo

string

required

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

pull_number

integer

required

The number that identifies the pull request.

Body Params application/json

body

string

required

The text of the review comment.

commit_id

string

required

The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

in_reply_to

integer

optional

The ID of the review comment to reply to. To find the ID of a review comment with "List review comments on a pull request". When specified, all parameters other than body in the request body are ignored.

Example:

line

integer

required

The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

path

string

required

The relative path to the file that necessitates a comment.

position

integer

deprecated

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

side

enum<string>

optional

In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

Allowed values:

LEFTRIGHT

start_line

integer

optional

Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

start_side

enum<string>

optional

Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

Allowed values:

LEFTRIGHTside

Examples

Responses

🟢201Response

application/json

Body

Pull Request Review Comments are comments on a portion of the Pull Request's diff.

_links

object

required

html

object

required

pull_request

object

required

self

object

required

author_association

enum<string>

required

How the author is associated with the repository.

Allowed values:

COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:

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:49.000Z

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

integer

required

The ID of the pull request review comment.

Example:

in_reply_to_id

integer

optional

The comment ID to reply to.

Example:

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:

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:

original_position

integer

required

The index of the original line in the diff to which the comment applies. This field is deprecated; use original_line instead.

Example:

original_start_line

integer | null

optional

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

Example:

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. This field is deprecated; use line instead.

Example:

pull_request_review_id

integer | null

required

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

Example:

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

object (Reaction Rollup)

optional

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

enum<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

Allowed values:

LEFTRIGHT

Default:

RIGHT

start_line

integer | null

optional

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

Example:

start_side

enum<string> | enum<null>

optional

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

Allowed values:

LEFTRIGHT

Default:

RIGHT

updated_at

string <date-time>

required

Example:

2011-04-14T16:00:49.000Z

url

string

required

URL for the pull request review comment

Example:

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

user

object (Simple User)

required

A GitHub user.

avatar_url

string <uri>

required

Example:

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

string | null

optional

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 | null

required

Example:

41d064eb2195891e12d0413f63227ea7

html_url

string <uri>

required

Example:

https://github.com/octocat

integer

required

Example:

string

required

Example:

octocat

name

string | null

optional

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

🟠403403

🟠422422