Skip to main content
PUT
/
notes
/
{id}
/
mark-read
Mark a note as read
curl --request PUT \
  --url https://api.salesive.com/api/v1/notes/{id}/mark-read \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Note marked as read",
  "data": {
    "_id": "66d1f0a3c2d4e5f6a7b8c9d0",
    "title": "Supplier contacts",
    "body": "Call Acme Co. for Q3 pricing.",
    "shop": "6680aabbccddeeff00112200",
    "user": "66a0c1d2e3f4a5b6c7d8e9f0",
    "createdAt": "2026-06-21T10:30:00.000Z",
    "updatedAt": "2026-06-21T12:00:00.000Z"
  }
}
Marks the note as read; no request body is needed. The store is bound to your app token server-side — never send a shop id.

Authorizations

​
Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Path Parameters

​
id
string
required

The note's id (Mongo ObjectId).

Response

The note was marked read.

Standard Salesive response envelope. The operation-specific payload is carried in data.

​
status
integer
required

HTTP status code, echoed in the body.

​
success
boolean
required

Whether the request succeeded.

​
message
string
required

Human-readable result message.

​
data
object

A note belonging to the store.