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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.github.com/repos///subscription' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ignored": false,
    "subscribed": true
}'

Response Example

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

Request

Path Params

owner

string

required

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

repo

string

required

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

Body Params application/json

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.

Examples

Responses

🟢200Response

application/json

Body

Repository invitations let you manage who you collaborate with.

created_at

string <date-time>

required

Example:

2012-10-06T21:34:12.000Z

ignored

boolean

required

Determines if all notifications should be blocked from this repository.

reason

string | null

required

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

Modified at 2023-08-15 02:59:27

Get a repository subscription

List repositories starred by the authenticated user