Set a thread subscription

PUT

/notifications/threads/{thread_id}/subscription

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.

API method documentation

Parameters

Path Parameters

thread_id

required

integer

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).

Request Body

Media type application/json

object

ignored

Whether to block all notifications from a thread.

boolean

Examples

Example default

{
  "ignored": false
}

Responses

200

Response

Media type application/json

Thread Subscription

Thread Subscription

object

subscribed

required

boolean

ignored

required

boolean

reason

required

string

nullable

created_at

required

string format: date-time

nullable

url

required

string format: uri

thread_url

string format: uri

repository_url

string format: uri

Examples

Example default

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

304

Not modified

401

Requires authentication

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Forbidden

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}