---
title: "Mark a notification as read"
method: PATCH
path: "/v1/notifications/{id}/read"
tags: ["Notifications"]
---

# Mark a notification as read

`PATCH /v1/notifications/{id}/read`

## Request

- Base URL: `https://api.signvoy.com`
- URL: `https://api.signvoy.com/v1/notifications/{id}/read`
- Auth: one of:
  - API key in header `X-Workspace-Id`
  - HTTP bearer

## Path parameters

- `id` string, uuid, required

## Response `200`

- NotificationDto
  - `id` string, uuid, required
  - `workspaceId` string, uuid, required
  - `userId` string, required
  - `type` 'recipient_signed' | 'document_completed' | 'document_declined' | 'document_expired', required
  - `title` string, required
  - `body` string, required
  - `documentId` string, uuid, nullable, required
  - `data` object, nullable, required
  - `readAt` string, date-time, nullable, required
  - `createdAt` string, date-time, required

---

[API](https://skmtc.dev/signvoy/apis/signvoy-api.md) · [All operations](https://skmtc.dev/signvoy/apis/signvoy-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signvoy/apis/signvoy-api/revisions/003cabc7cfe2?raw)