Set a repository subscription | Sample

2 parameters · 2 body fields

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

subscribedbooleanoptional

Determines if notifications should be received from this repository.

ignoredbooleanoptional

Determines if all notifications should be blocked from this repository.

1 status code

200Response

subscribedbooleanrequired

Determines if notifications should be received from this repository.

ignoredbooleanrequired

Determines if all notifications should be blocked from this repository.

reasonstringrequired

created_atstringrequired

urlstringrequired

repository_urlstringrequired

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.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.subscription.update({
  owner: "octocat",
  repo: "hello-world",
  subscribed: true,
  ignored: true,
});

{
  "subscribed": true,
  "ignored": false,
  "reason": null,
  "created_at": "2012-10-06T21:34:12Z",
  "url": "https://api.github.com/repos/octocat/example/subscription",
  "repository_url": "https://api.github.com/repos/octocat/example"
}

Was this helpful?

Request

Response