GitHub: Set a repository subscription

← Activity operations · Get started

Operation github.activity_set_repo_subscription

Provider route: PUT /repos/{owner}/{repo}/subscription. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["activity"]["activitySetRepoSubscription"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.activity.activitySetRepoSubscription(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.activity.activity_set_repo_subscription(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent
body	object	Optional
body.ignored	boolean	Optional	Determines if all notifications should be blocked from this repository.
body.subscribed	boolean	Optional	Determines if notifications should be received from this repository.

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get a repository subscription — response body

Referenced models: Get a repository subscription — response body

Schemas

Get a repository subscription — response body

Field	Type	Presence	Description and constraints
$	object	Root	Repository invitations let you manage who you collaborate with.
created_at	string	Required within parent	Format: date-time
ignored	boolean	Required within parent	Determines if all notifications should be blocked from this repository.
reason	JSON	Required within parent
reason (anyOf 1)	string	Alternative
reason (anyOf 2)	null	Alternative
repository_url	string	Required within parent	Format: uri
subscribed	boolean	Required within parent	Determines if notifications should be received from this repository.
url	string	Required within parent	Format: uri

Policy, approvals and errors

SDK function policy ID: github.activity_set_repo_subscription. Catalog operation: activity/set-repo-subscription. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source