Unpin an issue comment | GitHub API (unofficial showcase)

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 identifier of the comment to unpin.

6 status codes

204Returns no content after the issue comment is unpinned.

401Returned when authentication is required but missing or invalid.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

403Returned when the authenticated user is not permitted to unpin the comment.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Returned when the repository or comment cannot be found.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

410Returned when the resource is no longer available.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

503Returned when the service is unavailable.

codestringoptional

messagestringoptional

documentation_urlstringoptional

Error handling

A 401 is returned when authentication is missing or invalid. A 403 is returned when the authenticated user is not permitted to unpin the comment, a 404 when the repository or comment cannot be found, and a 410 when the resource is no longer available. A 503 is returned when the service is unavailable; the owner, repo, and comment_id path parameters must identify the intended repository and comment.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.pin.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"
}