NEnexla
Notifications

Mark Notification Read

Use this endpoint to mark one, multiple, or all notifications as read. To mark a list of notifications, send an array of notification IDs as the payload. To mark all notifications, send the notification_id query parameter with the value all.

put/notifications/mark_read

Request

Query parameters

'all'
OR
integer

The unique ID of one or more notifications, or enter "all" to mark all notifications as read. This can be used in place of an array of IDs in the request body.

asyncboolean

If set to 'true', request will be executed in a deferred way, and results will be provided later.

request_idinteger

The unique ID of the asynchronous request. In case it's provided, returns info about the deferred request.

Request body

integer[] required

Accepts a JSON array of notification IDs.

Response

Success

request_idinteger

The unique ID of the request that was executed. This ID can be used to track the status of the request.

status'pending' | 'running' | 'completed' | 'failed' | 'cancelled'
request_started_atstring date-time

The date and time when the request was started.

progressinteger

The progress of the request (value from 0 to 100). This value is a percentage of the total progress of the request. Applicable only to certain types of async operations.

resultobject

The result of the async operation. Format depends on the task type.

request_stopped_atstring date-time

The date and time when the request was stopped. This field is only present if the request has been stopped (due to cancellation or error).

request_completed_atstring date-time

The date and time when the request was completed. This field is only present if the request has been completed successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.