Skip to content
forgit api docs

Set a repository subscription

PUT
/repos/{owner}/{repo}/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.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

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

repo
required
string

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

Request Body

Section titled “ Request Body ”
Media type application/json
object
subscribed

Determines if notifications should be received from this repository.

boolean
ignored

Determines if all notifications should be blocked from this repository.

boolean
Examples
Example default 
{
  "subscribed": true,
  "ignored": false
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Repository Invitation

Repository invitations let you manage who you collaborate with.

object
subscribed
required

Determines if notifications should be received from this repository.

boolean
ignored
required

Determines if all notifications should be blocked from this repository.

boolean
reason
required
string
nullable
created_at
required
string format: date-time
url
required
string format: uri
repository_url
required
string format: uri
Examples
Example default 
{
  "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"
}