---
title: "Mark Notification Read"
method: PUT
path: "/notifications/mark_read"
tags: ["Notifications"]
---

# Mark Notification Read

`PUT /notifications/mark_read`

## Request

- Base URL: `https://dataops.nexla.io/nexla-api`
- URL: `https://dataops.nexla.io/nexla-api/notifications/mark_read`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nexla/apis/nexla-rest-api/docs/notifications/mark_read/put.ts> (a function with typed inputs; its response is checked against the schema)

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`.

## Query parameters

- `notification_id` union
  - 'all'
  - integer
- `async` boolean
- `request_id` integer

## Request body

- integer[]: Accepts a JSON array of notification IDs.

## Response `200`

Success

- AsyncOrNull: This object represents the response of an asynchronous operation. The response can be a dictionary or an array of dictionaries. The format of the response depends on the operation that was executed.
  - `request_id` integer: 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_at` string, date-time: The date and time when the request was started.
  - `progress` integer: 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.
  - `result` object: The result of the async operation. Format depends on the task type.
  - `request_stopped_at` string, 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_at` string, date-time: The date and time when the request was completed. This field is only present if the request has been completed successfully.

## Other responses

- `403`: Forbidden

---

[API](https://skmtc.dev/nexla/apis/nexla-rest-api.md) - [All operations](https://skmtc.dev/nexla/apis/nexla-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nexla/apis/nexla-rest-api/revisions/ef02be92fe7b?raw)
