Ejento APIs

Read Notification By ID

PUT

/api/notification/{notification_id}

Notification APIs

Marks a specific notification as read.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/api/notification/' \
--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

notification_id

integer

required

The ID of the notification to be marked as read.

Body Params application/json

org_id

integer

optional

The ID of the organization associated with the notification.

Example:

Examples

Responses

🟢200OK

application/json

Notification marked as read successfully.

Body

success

boolean

optional

Example:

true

message

string

optional

Example:

Notification modified successfully.

data

object

optional

integer

optional

Example:

40978

content

string

optional

Example:

File Indexed Successfully

is_read

boolean

optional

Example:

true

created_on

string <date-time>

optional

Example:

2024-10-22T20:34:28.004152Z

is_deleted

boolean

optional

Example:

false

recipient

integer

optional

Example:

org

integer

optional

Example:

agent

integer

optional

Example:

298

🟠400Bad Request

🟠401Unauthorized

Send Notification To User