Notifications

Update a notification

Changed on

Update a single notification, for example to mark it as viewed or archived by setting the relevant timestamp.

post/notifications.update

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/notifications.update
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

idstring uuid required

Unique identifier for the notification.

viewedAtstring date-time nullable

The date and time the notification was viewed, or null to mark it unviewed.

archivedAtstring date-time nullable

The date and time the notification was archived, or null to unarchive it.

Response

OK

Example response

{
  "data": {
    "actor": {
      "name": "Jane Doe"
    }
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes