Mark notification as read

Mark a single notification as read for the effective user.

Impersonation: When using the X-Impersonate-Email header, marks the notification as read for the target user.

POST /projects/{project_id}/notifications/{notification_id}/mark-as-read

Mark notification as read

Python

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/notifications/{notification_id}/mark-as-read/"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

200

{
  "scope": "project",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "unread",
  "access_level": "admin",
  "title": "Document processing completed",
  "message": "Your document 'Q4 Report.pdf' has been processed successfully.",
  "notification_type": "document_processed",
  "actions": {
    "primary": {
      "label": "View Document",
      "type": "navigate",
      "url": "/documents/123"
    }
  },
  "read_at": "2023-11-07T05:31:56Z",
  "source_object_type": "document",
  "source_object_id": "550e8400-e29b-41d4-a716-446655440000",
  "relative_time": "2 hours ago",
  "absolute_time": "2023-11-07T05:31:56Z"
}

Authorizations

BearerAuthTokenAuth

Authorization · string · header · required

Use Authorization: Bearer

Headers

X-Impersonate-Email · string<email>

Email of the user to impersonate. Requires CAN_IMPERSONATE_OTHER_USERS permission. If the target user is not found or does not have access to the project, the request proceeds as the authenticated user. Contact Clarifeye to enable this permission.

Path Parameters

project_id · string<uuid> · required

UUID of the project

notification_id · string<uuid> · required

UUID of the notification

Response

200

application/json

Notification marked as read

A project-scoped notification. Returned by project notification endpoints. The scope is always "project" and project is always a non-null UUID.

scope · enum<string> · required

Always "project" for project-scoped notifications

Available options: project

project · string<uuid> · required

UUID of the project this notification belongs to (always non-null)

id · string<uuid>

Unique identifier for the notification

created_at · string<date-time>

When the notification was created

updated_at · string<date-time>

When the notification was last updated

user · string<uuid>

ID of the user this notification belongs to

status · enum<string>

• unread: Notification has not been read
• read: Notification has been read

Available options: unread, read

access_level · enum<string>

• admin: Notification visible only to project admins
• viewer: Notification visible to all project members

Available options: admin, viewer

title · string

Notification title

Example:

"Document processing completed"

message · string

Notification message body

Example:

"Your document 'Q4 Report.pdf' has been processed successfully."

notification_type · string

Type/category of the notification

Example:

"document_processed"

actions · object

Optional actions that can be taken from the notification. Structure may include:

• primary: Primary action with label and type
• secondary: Array of secondary actions

Example:

{
  "primary": {
    "label": "View Document",
    "type": "navigate",
    "url": "/documents/123"
  }
}

read_at · string<date-time> | null

When the notification was marked as read (null if unread)

source_object_type · string

Type of the source object that triggered this notification

Example:

"document"

source_object_id · string

ID of the source object that triggered this notification

Example:

"550e8400-e29b-41d4-a716-446655440000"

relative_time · string

Human-readable relative time (e.g., "2 minutes ago", "Yesterday")

Example:

"2 hours ago"

absolute_time · string<date-time>

ISO format absolute timestamp