Set a thread subscription - GitHub v3 REST API

If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an @mention.

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.

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

Request

Path Params

thread_id

integer

required

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

Body Params application/json

ignored

boolean

optional

Whether to block all notifications from a thread.

Default:

false

Examples

Responses

🟢200Response

application/json

Body

Thread Subscription

created_at

string <date-time> | null

required

Example:

2012-10-06T21:34:12.000Z

ignored

boolean

required

reason

string | null

required

repository_url

string <uri>

optional

Example:

https://api.github.com/repos/1

subscribed

boolean

required

Example:

true

thread_url

string <uri>

optional

Example:

https://api.github.com/notifications/threads/1

url

string <uri>

required

Example:

https://api.github.com/notifications/threads/1/subscription

🔵304304

🟠401401

🟠403403