Skip to main content

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](https://docs.github.com/[email protected]/rest/reference/activity#delete-a-repository-subscription) completely.

PUT/repos/{owner}/{repo}/subscription
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
owner string
required
repo string
required
Body Params
optional
application/jsonobject
ignored boolean
optional

Determines if all notifications should be blocked from this repository.

subscribed boolean
optional

Determines if notifications should be received from this repository.

Responses

application/json Repository Invitation object

Response

created_at string<date-time>
required

Example: 2012-10-06T21:34:12Z

ignored boolean
required

Determines if all notifications should be blocked from this repository.

reason string
requirednullable
repository_url string<uri>
required

Example: https://api.github.com/repos/octocat/example

subscribed boolean
required

Determines if notifications should be received from this repository.

Example: true

url string<uri>
required

Example: https://api.github.com/repos/octocat/example/subscription