Mark notification as read

Mark a specific notification as read

patch/api/v1/notifications/{id}/read

Request

Base URL: http://localhost:8080
URL: http://localhost:8080/api/v1/notifications/{id}/read
Auth: bearerAuth (a scheme the document does not define)

Path parameters

idstring uuid required

Notification UUID

Response

Notification marked as read

successtrue required

messagestring

Example response

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "info",
    "title": "Reporte semanal enviado",
    "message": "Se ha enviado tu reporte semanal de Mi Organización",
    "metadata": {
      "schemaVersion": 1,
      "event": "reports.weekly.delivered",
      "source": "weekly-report-sender",
      "orgId": "550e8400-e29b-41d4-a716-446655440000",
      "link": {
        "type": "internal",
        "path": "/orgs/550e8400-e29b-41d4-a716-446655440000/analytics"
      },
      "url": "/orgs/550e8400-e29b-41d4-a716-446655440000/analytics",
      "entity": {
        "type": "organization",
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    },
    "createdAt": "2025-03-10T12:00:00Z"
  }
}

Changes

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