Read Notifications By User ID

PUT

/v2/api/notification

Allows authenticated users to mark all notifications as read for a specific user by providing the user_id as a query parameter and the org_id in the request body.

Functionality

Updates all notifications associated with the specified user, setting is_read to true.

Requires both the user ID (as a query parameter) and the organization ID (in the request body).

Designed to help users or administrators manage notification statuses efficiently.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "success": true,
    "message": "Notification modified successfully.",
    "data": [
        {
            "id": 71615,
            "content": "Testing Notifications APIs",
            "is_read": true,
            "created_on": "2025-02-06T17:16:25.233818Z",
            "is_deleted": false,
            "redirection_details": {},
            "recipient": 147,
            "org": 1,
            "agent": 1297
        }
    ]
}

Request

Query Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Notifications successfully marked as read.

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Retrieve All Notifications

Retrieve Notification