API for archiving a notification (marking as done)

[aspiers]

Select Topic Area

Product Feedback

Body

The GitHub website and mobile app are both able to mark individual notifications as done; however there does not appear to be any API mechanism documented which allows this, either in the REST API or the GraphQL API.

The REST API only allows marking notifications as read, not as done:

https://docs.github.com/en/rest/activity/notifications?apiVersion=2022-11-28#mark-notifications-as-read

and I can't find anything about notifications in the GraphQL API at all (maybe they're there, but just not easily discoverable).

However, sniffing the network traffic when archiving a notification from https://github.com/notifications reveals a beta API:

It would be great if this was brought out of beta and fully documented!

[morgen-peschke]

This would be particularly nice as the current UI does not have great UX for tasks like "archive all notifications for closed PRs"

[andrew]

You can make a saved search for type:pull_request state:merged,closed which will give you a fairly quick way of archiving them all. I used state:merged,closed inbox:true starred:false as a search I called "Archivable"

[joshbeard]

Maybe this is implied, but it'd also be helpful to filter on this status when retrieving notifications. The UI currently defaults to "not done" notifications, distinctly separate from "unread".

[andrew]

@aspiers I took a look at their beta endpoint but I believe it requires a different kind of authentication token than is provided by the official api so we can't use the unofficial one as a hack, will need to wait for it to be implemented.

@joshbeard yes if we can retrieve the "done" state from the api we can provide filters and searches on that field.

If you'd like to see this feature I recommend contacting github customer support and requesting the api be made public, the more people that ask, the most likely it will happen.

[pradyunsg]

https://support.github.com/contact?tags=rr-general-technical is the current relevant URL, to reach out to customer support for "general technical" stuff by the looks of it.

[rmacklin]

This API has been introduced: https://docs.github.com/en/rest/activity/notifications?apiVersion=2022-11-28#mark-a-thread-as-done

However, there still doesn't seem to be an API parameter to filter notifications using is:done (or not) like we can in the web UI. This makes it difficult to actually make use of the "mark as done" API for integrations like gh-notify: meiji163/gh-notify#47 (comment)

[thehesiod]

I was hoping to write a script to mark all my not-done notifications done, however the notifications list api returns done notifications as well :(

[balusena]

Create a saved search with "type:pull_request state:merged,closed" for quick archiving. Alternatively, use "state:merged,closed inbox:true starred:false" as a search termed "Archivable" for efficient management of pull requests.