GitHub API (unofficial showcase)
PUT/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals

Dismiss a pull request review

Submits a dismissal for a specified review on a pull request in a repository. Provide the required message; event can only be DISMISS and is optional. For protected branches, you must be a repository administrator or be included in the people or teams allowed to dismiss reviews; a successful response returns the dismissed review.

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 number that identifies the pull request.
review_idintegerrequired
The unique identifier of the review to dismiss.

Review dismissal details.

messagestringrequired
The message for the pull request review dismissal
eventstringoptional
The dismissal event. Must be `DISMISS` if provided.
Allowed:DISMISS

3 status codes
200Returns the dismissed pull request review, including its identifier, state, body, commit ID, and links. The response body representation depends on the requested media type.
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 repository, pull request, or review cannot be found.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Returned when validation fails or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<string>optional

Error handling

A 404 is returned when the owner path parameter, repo path parameter, pull_number path parameter, or review_id path parameter does not identify a resource. A 422 is returned when validation fails or the endpoint has been spammed. message is required, and event must be DISMISS if provided.