---
title: Mark notification as read
slug: api-documentation/mark-notification-as-read
docTags: 
createdAt: 2026-08-27T16:57:16.574Z
---

{
  "id": "o2I8QYRMu49_qyn6TTqNR",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "https://api.upstartcommerce.com/notifications/v1/notifications/{notificationId}/read",
    "servers": [
      {
        "url": "https://api.upstartcommerce.com/notifications/v1/notifications/{notificationId}/read",
        "description": "Production server"
      },
      {
        "url": "https://staging-api.upstartcommerce.com/notifications/v1/notifications/{notificationId}/read",
        "description": "Staging server"
      },
      {
        "url": "http://localhost:8080/api/v1/notifications/{notificationId}/read",
        "description": "Local development server"
      }
    ],
    "name": "Mark notification as read",
    "description": "<p>Mark a specific notification as read.</p>\n<p><strong>Security</strong>: Requires <code>notification:manage</code> permission.\nUsers can only modify their own notifications.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "notificationId",
          "type": "string<uuid>",
          "description": "Notification ID",
          "format": "uuid"
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "oauth2",
          "name": "oauth2",
          "kind": "optional",
          "type": "oauth2",
          "description": "OAuth2 with JWT bearer tokens",
          "oauth2Flows": {
            "clientCredentials": {
              "tokenUrl": "https://auth.upstartcommerce.com/oauth/token",
              "scopes": {
                "notification:manage": "Full access to manage own notifications"
              }
            },
            "authorizationCode": {
              "authorizationUrl": "https://auth.upstartcommerce.com/oauth/authorize",
              "tokenUrl": "https://auth.upstartcommerce.com/oauth/token",
              "scopes": {
                "notification:manage": "Full access to manage own notifications"
              }
            }
          },
          "requiredScopes": [
            "notification:manage"
          ]
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Notification marked as read",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "MarkAsReadResponse",
            "schema": [
              {
                "name": "success",
                "kind": "required",
                "type": "boolean",
                "description": "Whether the operation was successful"
              },
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "description": "<p>Human-readable result message</p>"
              }
            ],
            "modelRef": "#/components/schemas/MarkAsReadResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "Authentication failed",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "error",
                "kind": "required",
                "type": "string<authentication_failed | insufficient_permissions | invalid_request | not_found>",
                "description": "Error code",
                "enum": [
                  "authentication_failed",
                  "insufficient_permissions",
                  "invalid_request",
                  "not_found"
                ]
              },
              {
                "name": "error_description",
                "kind": "required",
                "type": "string",
                "description": "<p>Human-readable error description</p>"
              },
              {
                "name": "required_scope",
                "kind": "optional",
                "type": "string",
                "description": "<p>Required OAuth2 scope (for permission errors)</p>"
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "403",
        "description": "Insufficient permissions",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "error",
                "kind": "required",
                "type": "string<authentication_failed | insufficient_permissions | invalid_request | not_found>",
                "description": "Error code",
                "enum": [
                  "authentication_failed",
                  "insufficient_permissions",
                  "invalid_request",
                  "not_found"
                ]
              },
              {
                "name": "error_description",
                "kind": "required",
                "type": "string",
                "description": "<p>Human-readable error description</p>"
              },
              {
                "name": "required_scope",
                "kind": "optional",
                "type": "string",
                "description": "<p>Required OAuth2 scope (for permission errors)</p>"
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "404",
        "description": "Notification not found or access denied",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "error",
                "kind": "required",
                "type": "string<authentication_failed | insufficient_permissions | invalid_request | not_found>",
                "description": "Error code",
                "enum": [
                  "authentication_failed",
                  "insufficient_permissions",
                  "invalid_request",
                  "not_found"
                ]
              },
              {
                "name": "error_description",
                "kind": "required",
                "type": "string",
                "description": "<p>Human-readable error description</p>"
              },
              {
                "name": "required_scope",
                "kind": "optional",
                "type": "string",
                "description": "<p>Required OAuth2 scope (for permission errors)</p>"
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "CnXrv29jiZFwebl3thkGi",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url https://api.upstartcommerce.com/notifications/v1/notifications/{notificationId}/read \\\n     --header 'accept: application/json'"
        },
        {
          "id": "7rqZyKBDGpsow0x0QA7Dz",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/notifications/v1/notifications/{notificationId}/read\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "tZ5GbcPE-Rdly1EQTFRSo",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/notifications/v1/notifications/{notificationId}/read\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "ZPkpt3zfQMJz6Y3FrBjkq",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/notifications/v1/notifications/{notificationId}/read\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "CnXrv29jiZFwebl3thkGi"
    },
    "results": {
      "languages": [
        {
          "id": "xqyNmQDrnQAQI-SduRZeR",
          "language": "200",
          "code": "// Notification marked as read\n{\n  \"success\": false,\n  \"message\": \"\"\n}"
        },
        {
          "id": "tSrmJVDibWaGXwE4AIt1d",
          "language": "401",
          "code": "// Authentication failed\n{\n  \"error\": \"\",\n  \"error_description\": \"\",\n  \"required_scope\": \"\"\n}"
        },
        {
          "id": "Brxerug1NzwiPo-oseuKx",
          "language": "403",
          "code": "// Insufficient permissions\n{\n  \"error\": \"\",\n  \"error_description\": \"\",\n  \"required_scope\": \"\"\n}"
        },
        {
          "id": "RtYzQSuKKYIK9TLINe_Hm",
          "language": "404",
          "code": "// Notification not found or access denied\n{\n  \"error\": \"\",\n  \"error_description\": \"\",\n  \"required_scope\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "xqyNmQDrnQAQI-SduRZeR"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}