Read Notification

PUT

/v2/api/notification/{notification_id}

Allows authenticated users to mark a specific notification as read by providing its unique notification_id in the path and the org_id in the request body.

Functionality

Updates the read status (is_read) of a notification to true.

Ensures the change is applied to the correct organization context by requiring org_id.

What is a Notification ID?

A Notification ID is a unique identifier assigned to each notification generated within a system.
It acts as a reference ID that helps in tracking, managing, and interacting with specific notifications.

Purpose of Notification ID

To uniquely identify a notification in the system.

To perform operations like marking as read, deleting, or updating a specific notification.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT 'https:///v2/api/notification/0' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "org_id": 1
}'

Response Example

{
    "success": true,
    "message": "Notification modified successfully.",
    "data": {
        "id": 40978,
        "content": "File Indexed Successfully",
        "is_read": true,
        "created_on": "2024-10-22T20:34:28.004152Z",
        "is_deleted": false,
        "recipient": 15,
        "org": 1,
        "agent": 298
    }
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Notification marked as read successfully.

Body

🟠400Bad Request

🟠401Unauthorized

Retrieve Notification

Delete Notification

Read Notification

What is a Notification ID?#

Purpose of Notification ID#

Request

Responses

What is a Notification ID?

Purpose of Notification ID