Skip to main content
POST
/
notifications
/
toggle
Toggle Notification Read Status
curl --request POST \
  --url https://api.example.com/notifications/toggle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "notificationIds": [
    123
  ],
  "newRead": true
}
'
[
  {
    "id": 123,
    "type": "quote",
    "userId": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "actorId": 123,
    "postId": 123,
    "read": true
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-API-KEY
string
required

API key required for authentication

Body

application/json
​
notificationIds
integer[]
required

List of notification IDs to update

​
newRead
boolean
required

New read status to apply to the notifications

Response

The updated notifications

​
id
integer
​
type
enum<string>
Available options:
quote,
reply,
repost,
mention,
follow
​
userId
integer
​
createdAt
string<date-time>
​
actorId
integer
​
postId
integer | null
​
read
boolean