---
title: "Mark a notification read"
method: POST
path: "/v1/me/notifications/{notification}/read"
tags: ["Notifications"]
---

# Mark a notification read

`POST /v1/me/notifications/{notification}/read`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/me/notifications/{notification}/read`
- Auth: HTTP bearer

```bash
curl -X POST https://api.subscriby.net/v1/me/notifications/$NOTIFICATION_ID/read \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
```

Answers `200` with the entry, `read` now `true`. Idempotent: an entry already read keeps its first `read_at`.

## Path parameters

- `notification` string, required

## Headers

- `Idempotency-Key` string, uuid, required

## Response `200`

200 with the row, read.

- object
  - `data` NotificationResource, required: One entry of the creator's Notifications Center: an alert Subscriby sent them, with where it points and whether they opened it.
    - `id` string, required: The entry's id, the value the mark-read endpoint takes.
    - `class` string, required: The alert class the creator routes on Settings → Notifications: `sales`, `support`, `recovery`, `billing`, `security`, `passes` or `onboarding`.
    - `class_label` 'Sales' | 'Support' | 'Recovery' | 'Billing' | 'Security' | 'Passes' | 'Onboarding' | 'Partner Program' | 'Revenue Recovery', required: The class's name in the creator's language.
    - `title` string, required: The alert's heading, the same words the email used, in the creator's language at the time it was sent.
    - `body` string, required: One sentence of context, the email's first line.
    - `route` string, nullable, required: The dashboard screen the entry opens, as a named route, for a client that maps routes to screens; null when the alert points nowhere.
    - `params` object, required: The named route's parameters; null when the alert points nowhere.
    - `url` string, nullable, required: The same place resolved to a URL, for a client that does not map routes; null when the alert points nowhere.
    - `read` boolean, required: Whether the creator opened the entry.
    - `read_at` string, nullable, required: When it was opened, ISO 8601; null while unread.
    - `created_at` string, nullable, required: When the alert arrived, ISO 8601.

## Other responses

- `400`: `IDEMPOTENCY_KEY_MISSING`: every write needs an `Idempotency-Key` header. Send a fresh UUID per distinct operation.
- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred. On this endpoint: `RESOURCE_NOT_FOUND`: for an id that is not one of the caller's entries.
- `409`: `IDEMPOTENCY_KEY_REUSED`: the key was already used in the last 24 hours with a different request body.
- `425`: `IDEMPOTENCY_REPLAY_IN_PROGRESS`: the first request with this key is still running; retry in a few seconds and the original response is replayed.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)