POST
/
v1
/
subscribers
/
{subscriberId}
/
messages
/
mark-as
import { Novu } from "@novu/api";
import { MarkAs } from "@novu/api/models/components";

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.subscribers.messages.markAllAs("<value>", {
  messageId: "<value>",
    markAs: MarkAs.Seen,
  });

  // Handle the result
  console.log(result)
}

run();
[
  {}
]

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

This API marks a single message of one subscriber as read, unread, seen, unseen. This API requires messageId to be passed.

Authorizations

​
Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Path Parameters

​
subscriberId
string
required

Body

application/json
​
messageId
required
​
markAs
enum<string>
required
Available options:
read,
seen,
unread,
unseen

Response

201
application/json

The response is of type object[].

Was this page helpful?