Sample - GitHub REST API
PUT/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals

Dismiss a pull request review

Dismisses a specified review on a pull request. Provide owner, repo, pull_number, review_id, and a dismissal message; if you send event, its value must be DISMISS. To dismiss a review on a protected branch, you must be a repository administrator or be included among the people or teams permitted to dismiss reviews.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 parameters · 2 body fields
ownerstringrequired
The account owner of the repository; the name is not case sensitive.
repostringrequired
The repository name without the `.git` extension; the name is not case sensitive.
pull_numberintegerrequired
The integer identifying the pull request.
review_idintegerrequired
The integer uniquely identifying the review to dismiss.

The pull request review dismissal details.

messagestringrequired
The message for the pull request review dismissal
eventstringoptional
The dismissal event; when provided, it must be `DISMISS`.
Allowed:DISMISS

3 status codes
200Returns the dismissed pull request review object, including its identifier, author, message, state, commit, associated URLs, and author association.
idintegerrequired
Unique identifier of the review
node_idstringrequired
userobjectrequired
A GitHub user.
bodystringrequired
The text of the review.
statestringrequired
html_urlstringrequired
pull_request_urlstringrequired
_linksobjectrequired
submitted_atstringoptional
commit_idstringrequired
A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.
body_htmlstringoptional
body_textstringoptional
author_associationstringrequired
How the author is associated with the repository.
Allowed:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER
404Returned when the specified repository, pull request, or review does not exist.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Returned when the request fails validation or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<string>optional

Error handling

A 404 is returned when the repository, pull request, or review cannot be found. A 422 is returned when validation fails or the endpoint has been spammed. message is required, and event, when supplied, must be DISMISS; protected-branch reviews also require the documented dismissal permission.