Skip to main content
POST
/
api
/
v1
/
notifications
/
mark-read
Mark Read
curl --request POST \
  --url https://platform.unstructuredapp.io/api/v1/notifications/mark-read \
  --header 'Content-Type: application/json' \
  --data '
{
  "notification_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "before": "2023-11-07T05:31:56Z",
  "mark_all": false,
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "marked_count": 123
}

Headers

​
unstructured-api-key
string | null

Body

application/json

Request to mark notifications as read.

Provide ONE of: notification_ids, before, or mark_all (mutually exclusive). workflow_id is valid with 'before' or 'mark_all'.

​
notification_ids
string<uuid>[] | null

Specific notification IDs to mark as read (max 100)

Maximum array length: 100
​
before
string<date-time> | null

Mark all notifications created before this ISO 8601 timestamp as read

​
mark_all
boolean
default:false

Mark all unread notifications as read (can combine with workflow_id)

​
workflow_id
string<uuid> | null

Filter by workflow (only valid with 'before' or 'mark_all')

Response

Successful Response

Response for mark-as-read operation.

​
marked_count
integer
required

Number of events newly marked as read