activity

Set a repository subscription

If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.

put/repos/{owner}/{repo}/subscription

Request

  • Base URL: http://HOSTNAME/api/v3
  • URL: http://HOSTNAME/api/v3/repos/{owner}/{repo}/subscription
  • Auth: none declared

Path parameters

ownerstring required

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

repostring required

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

Request body

subscribedboolean

Determines if notifications should be received from this repository.

ignoredboolean

Determines if all notifications should be blocked from this repository.

Response

Response

subscribedboolean required

Determines if notifications should be received from this repository.

ignoredboolean required

Determines if all notifications should be blocked from this repository.

reasonstring nullable required
created_atstring date-time required
urlstring uri required
repository_urlstring uri required

Example response

{
  "subscribed": true,
  "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"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.