Mark a subscriber messages as seen, read, unseen or unread

POST

subscribers

{subscriberId}

messages

mark-as

Authorizations

Authorization

string

header

required

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

Headers

idempotency-key

string

A header for idempotency purposes

Path Parameters

subscriberId

string

required

Body

application/json

markAs

enum<string>

required

Available options:

read,

seen,

unread,

unseen

messageId

required

Response

201 - application/json

_environmentId

string

required

Environment ID where the message is sent

_messageTemplateId

string

required

Message template ID

_notificationId

string

required

Notification ID associated with the message

_organizationId

string

required

Organization ID associated with the message

_subscriberId

string

required

Subscriber ID associated with the message

_templateId

string

required

Template ID associated with the message

channel

enum<string>

required

Channel type through which the message is sent

Available options:

in_app,

email,

sms,

chat,

push

content

required

Content of the message, can be an email block or a string

createdAt

string

required

Creation date of the message

cta

object

required

Call to action associated with the message

read

boolean

required

Indicates if the message has been read

seen

boolean

required

Indicates if the message has been seen

status

enum<string>

required

Status of the message

Available options:

sent,

error,

warning

transactionId

string

required

Transaction ID associated with the message

_feedId

string | null

Feed ID associated with the message, if applicable

_id

string

Unique identifier for the message

deviceTokens

string[]

Device tokens associated with the message, if applicable

directWebhookUrl

string

Direct webhook URL for the message, if applicable

string

Email address associated with the message, if applicable

errorId

string

Error ID if the message has an error

errorText

string

Error text if the message has an error

lastReadDate

string

Last read date of the message, if available

lastSeenDate

string

Last seen date of the message, if available

overrides

object

Provider specific overrides used when triggering the notification

payload

object

The payload that was used to send the notification trigger

phone

string

Phone number associated with the message, if applicable

providerId

string

Provider ID associated with the message, if applicable

subject

string

Subject of the message, if applicable

subscriber

object

Subscriber details, if available

subscriber._environmentId

string

required

The unique identifier of the environment associated with this subscriber.

subscriber._organizationId

string

required

The unique identifier of the organization to which the subscriber belongs.

subscriber.createdAt

string

required

The timestamp indicating when the subscriber was created, in ISO 8601 format.

subscriber.deleted

boolean

required

Indicates whether the subscriber has been deleted.

subscriber.subscriberId

string

required

The identifier used to create this subscriber, which typically corresponds to the user ID in your system.

subscriber.updatedAt

string

required

The timestamp indicating when the subscriber was last updated, in ISO 8601 format.

subscriber.__v

number

The version of the subscriber document.

subscriber._id

string

The internal ID generated by Novu for your subscriber. This ID does not match the subscriberId used in your queries. Refer to subscriberId for that identifier.

subscriber.avatar

string

The URL of the subscriber's avatar image.

subscriber.channels

object[]

An array of channel settings associated with the subscriber.

subscriber.data

object | null

Additional custom data for the subscriber

subscriber.email

string | null

The email address of the subscriber.

subscriber.firstName

string

The first name of the subscriber.

subscriber.isOnline

boolean

Indicates whether the subscriber is currently online.

subscriber.lastName

string

The last name of the subscriber.

subscriber.lastOnlineAt

string

The timestamp indicating when the subscriber was last online, in ISO 8601 format.

subscriber.locale

string

The locale setting of the subscriber, indicating their preferred language or region.

subscriber.phone

string

The phone number of the subscriber.

subscriber.timezone

string

Timezone of the subscriber

subscriber.topics

string[]

deprecated

An array of topics that the subscriber is subscribed to.

template

object

Workflow template associated with the message

template._creatorId

string

required

template._environmentId

string

required

template._notificationGroupId

string

required

template._organizationId

string

required

template.active

boolean

required

template.critical

boolean

required

template.deleted

boolean

required

template.deletedAt

string

required

template.deletedBy

string

required

template.description

string

required

template.draft

boolean

required

template.name

string

required

template.preferenceSettings

object

required

template.steps

object[]

required

template.steps._id

string

Unique identifier for the notification step.

template.steps._parentId

string

ID of the parent notification step, if applicable.

template.steps._templateId

string

ID of the template associated with this notification step.

template.steps.active

boolean

Indicates whether the notification step is active.

template.steps.filters

object[]

Filters applied to this notification step.

template.steps.metadata

object

Metadata associated with the workflow step. Can vary based on the type of step.

template.steps.name

string

Name of the notification step.

template.steps.replyCallback

object

Callback information for replies, including whether it is active and the callback URL.

template.steps.shouldStopOnFail

boolean

Determines if the process should stop on failure.

template.steps.template

object

Message template used in this notification step.

template.steps.uuid

string

Universally unique identifier for the notification step.

template.steps.variants

object[]

template.steps.variants._id

string

Unique identifier for the notification step.

template.steps.variants._parentId

string

ID of the parent notification step, if applicable.

template.steps.variants._templateId

string

ID of the template associated with this notification step.

template.steps.variants.active

boolean

Indicates whether the notification step is active.

template.steps.variants.filters

object[]

Filters applied to this notification step.

template.steps.variants.metadata

object

Metadata associated with the workflow step. Can vary based on the type of step.

template.steps.variants.name

string

Name of the notification step.

template.steps.variants.replyCallback

object

Callback information for replies, including whether it is active and the callback URL.

template.steps.variants.shouldStopOnFail

boolean

Determines if the process should stop on failure.

template.steps.variants.template

object

Message template used in this notification step.

template.steps.variants.uuid

string

Universally unique identifier for the notification step.

template.tags

string[]

required

template.triggers

object[]

required

template._id

string

template._parentId

string

template.data

object

template.notificationGroup

object

template.workflowIntegrationStatus

object

templateIdentifier

string

Identifier for the message template

title

string

Title of the message, if applicable

Was this page helpful?

Suggest edits Raise issue

Get the unseen in-app notifications count for subscribers feed Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.

API Reference

Events

Notifications

Integrations

Subscribers

Messages

Topics

Mark a subscriber messages as seen, read, unseen or unread

Authorizations

Headers

Path Parameters

Body

Response