Review a pull request

POST {{baseUrl}}/pull-requests/{{pullRequestId}}/tasks

Updates the [review] status of a pull request. Include the following in the request body:

  • action — (Required) A string that contains the action to perform on the pull request review:

    • approve — Approve the pull request for merge.
    • decline — Decline the pull request.
    • merge — Merge the pull request into its parent element.
    • unapprove — Revokes a pull request's approve status. This action does not decline the pull request.
  • comment — If the pull request action is decline, a string that contains a comment about why the pull request was declined.

Request Body

{"action"=>"{{pullRequestAction}}", "comment"=>"{{declineComment}}"}

RESPONSES

status: OK

{"id":"4e1a6609-1a29-4037-a411-89ecc14c6cd8","reviewedBy":{"id":12345678,"name":"Taylor Lee","username":"taylor-lee"},"status":"open","updatedAt":"2024-02-21T08:19:09.000Z"}