Mark Notifications Read

POST

/api/canvas/notifications/mark-read

curl --request POST \
  --url https://example.com/api/canvas/notifications/mark-read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "notification_ids": [ "example" ] }'

Mark specific notifications as read for the current user.

Authorizations

• HTTPBearer

Request Body^required

Media typeapplication/json

MarkReadRequest

object

notification_ids

required

Notification Ids

Array<string>

<= 50 items

Example^generated

{
  "notification_ids": [
    "example"
  ]
}

Responses

200

Successful Response

Media typeapplication/json

MarkReadResponse

object

marked_count

required

Marked Count

integer

unread_count

required

Unread Count

integer

Example^generated

{
  "marked_count": 1,
  "unread_count": 1
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}