Delete a pull request review comment | Sample

3 parameters

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.

comment_idintegerrequired

The unique 64-bit integer identifier of the review comment to delete.

2 status codes

204Returns no content after the review comment has been deleted.

404Returned when the repository or review comment does not exist.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned when the repository or review comment cannot be found. comment_id must be the comment's 64-bit integer identifier, and owner and repo must identify the target repository.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.comments.delete({
  owner: "octocat",
  repo: "hello-world",
  commentId: "c0a80123-4567-89ab-cdef-0123456789ab",
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors