Mark notifications as read

PUT

/notifications

Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the List notifications for the authenticated user endpoint and pass the query parameter all=false.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.github.com/notifications' \
--header 'Content-Type: application/json' \
--data-raw '{
    "last_read_at": "2022-06-10T00:00:00.000Z",
    "read": true
}'

Response Example

202 - Example 1

{
    "message": "string"
}

Request

Body Params application/json

last_read_at

string <date-time>

optional

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

read

boolean

optional

Whether the notification has been read.

Examples

Responses

🟢202Response

application/json

Body

message

string

optional

🟢205Reset Content

🔵304304

🟠401401

🟠403403

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

List notifications for the authenticated user

Get a thread