Skip to main content
Manja / GitHub

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

PUT/notifications/threads/{thread_id}/subscription
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
thread_id integer
required

thread_id parameter

Body Params
optional
application/jsonobject
ignored boolean
optional

Whether to block all notifications from a thread.

Default: false

Responses

application/json Thread Subscription object

Response

created_at string<date-time>
requirednullable

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

ignored boolean
required
reason string
requirednullable
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

Not modified

application/json Basic Error object

Requires authentication

documentation_url string
optional
message string
optional
status string
optional
url string
optional
application/json Basic Error object

Forbidden

documentation_url string
optional
message string
optional
status string
optional
url string
optional