Marks a message as read/unread, seen/unseen.

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

markAs

enum<string>

required

Available options:

read,

seen,

unread,

unseen

messageId

required

Response

201 - application/json

data

object[]

Show child attributes

data._environmentId

string

required

Environment ID where the message is sent

data._messageTemplateId

string

required

Message template ID

data._notificationId

string

required

Notification ID associated with the message

data._organizationId

string

required

Organization ID associated with the message

data._subscriberId

string

required

Subscriber ID associated with the message

data._templateId

string

required

Template ID associated with the message

data.channel

enum<string>

required

Channel type through which the message is sent

Available options:

in_app,

email,

sms,

chat,

push

data.content

required

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

Show child attributes

data.content.content

string

required

Content of the email block

data.content.type

enum<string>

required

Type of the email block

Available options:

button,

text

data.content.styles

object

Styles applied to the email block

Show child attributes

data.content.styles.textAlign

enum<string>

required

Text alignment for the email block

Available options:

center,

left,

right

data.content.url

string

URL associated with the email block, if any

data.createdAt

string

required

Creation date of the message

data.cta

object

required

Call to action associated with the message

Show child attributes

data.cta.data

object

required

Data associated with the call to action

Show child attributes

data.cta.data.url

string

URL for the call to action

data.cta.action

object

Action associated with the call to action

Show child attributes

data.cta.action.buttons

object[]

List of buttons associated with the message action

Show child attributes

data.cta.action.buttons.content

string

required

Content of the button

data.cta.action.buttons.type

enum<string>

required

Type of button for the action result

Available options:

primary,

secondary

data.cta.action.buttons.resultContent

string

Content of the result when the button is clicked

data.cta.action.result

object

Result of the message action

Show child attributes

data.cta.action.result.payload

object

Payload of the action result

data.cta.action.result.type

enum<string>

Type of button for the action result

Available options:

primary,

secondary

data.cta.action.status

enum<string>

Status of the message action

Available options:

pending,

done

data.cta.type

enum<string>

Type of call to action

Available options:

redirect

data.read

boolean

required

Indicates if the message has been read

data.seen

boolean

required

Indicates if the message has been seen

data.status

enum<string>

required

Status of the message

Available options:

sent,

error,

warning

data.transactionId

string

required

Transaction ID associated with the message

data._feedId

string | null

Feed ID associated with the message, if applicable

data._id

string

Unique identifier for the message

data.deviceTokens

string[]

Device tokens associated with the message, if applicable

data.directWebhookUrl

string

Direct webhook URL for the message, if applicable

data.email

string

Email address associated with the message, if applicable

data.errorId

string

Error ID if the message has an error

data.errorText

string

Error text if the message has an error

data.lastReadDate

string

Last read date of the message, if available

data.lastSeenDate

string

Last seen date of the message, if available

data.overrides

object

Provider specific overrides used when triggering the notification

data.payload

object

The payload that was used to send the notification trigger

data.phone

string

Phone number associated with the message, if applicable

data.providerId

string

Provider ID associated with the message, if applicable

data.subject

string

Subject of the message, if applicable

data.subscriber

object

Subscriber details, if available

Show child attributes

data.subscriber._environmentId

string

required

The unique identifier of the environment associated with this subscriber.

data.subscriber._organizationId

string

required

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

data.subscriber.createdAt

string

required

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

data.subscriber.deleted

boolean

required

Indicates whether the subscriber has been deleted.

data.subscriber.subscriberId

string

required

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

data.subscriber.updatedAt

string

required

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

data.subscriber.__v

number

The version of the subscriber document.

data.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.

data.subscriber.avatar

string

The URL of the subscriber's avatar image.

data.subscriber.channels

object[]

An array of channel settings associated with the subscriber.

Show child attributes

data.subscriber.channels._integrationId

string

required

The unique identifier of the integration associated with this channel.

data.subscriber.channels.credentials

object

required

Credentials payload for the specified provider

Show child attributes

data.subscriber.channels.credentials.alertUid

string

Alert UID for Grafana on-call webhook payload.

data.subscriber.channels.credentials.channel

string

Channel specification for Mattermost chat notifications.

data.subscriber.channels.credentials.deviceTokens

string[]

Contains an array of the subscriber device tokens for a given provider. Used on Push integrations.

data.subscriber.channels.credentials.externalUrl

string

Link to upstream details property for Grafana on-call webhook.

data.subscriber.channels.credentials.imageUrl

string

Image URL property for Grafana on-call webhook.

data.subscriber.channels.credentials.state

string

State property for Grafana on-call webhook.

data.subscriber.channels.credentials.title

string

Title to be used with Grafana on-call webhook.

data.subscriber.channels.credentials.webhookUrl

string

Webhook URL used by chat app integrations. The webhook should be obtained from the chat app provider.

data.subscriber.channels.providerId

enum<string>

required

The provider identifier for the credentials

Available options:

slack,

discord,

msteams,

mattermost,

ryver,

zulip,

grafana-on-call,

getstream,

rocket-chat,

whatsapp-business,

fcm,

apns,

expo,

one-signal,

pushpad,

push-webhook,

pusher-beams

data.subscriber.channels.integrationIdentifier

string

The integration identifier

data.subscriber.email

string | null

The email address of the subscriber.

data.subscriber.firstName

string

The first name of the subscriber.

data.subscriber.isOnline

boolean

Indicates whether the subscriber is currently online.

data.subscriber.lastName

string

The last name of the subscriber.

data.subscriber.lastOnlineAt

string

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

data.subscriber.locale

string

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

data.subscriber.phone

string

The phone number of the subscriber.

data.subscriber.topics

string[]

An array of topics that the subscriber is subscribed to.

data.template

object

Workflow template associated with the message

Show child attributes

data.template._creatorId

string

required

data.template._environmentId

string

required

data.template._notificationGroupId

string

required

data.template._organizationId

string

required

data.template.active

boolean

required

data.template.critical

boolean

required

data.template.deleted

boolean

required

data.template.deletedAt

string

required

data.template.deletedBy

string

required

data.template.description

string

required

data.template.draft

boolean

required

data.template.name

string

required

data.template.preferenceSettings

object

required

Show child attributes

data.template.preferenceSettings.chat

boolean

data.template.preferenceSettings.email

boolean

data.template.preferenceSettings.in_app

boolean

data.template.preferenceSettings.push

boolean

data.template.preferenceSettings.sms

boolean

data.template.steps

object[]

required

Show child attributes

data.template.steps._id

string

Unique identifier for the notification step.

data.template.steps._parentId

string

ID of the parent notification step, if applicable.

data.template.steps._templateId

string

ID of the template associated with this notification step.

data.template.steps.active

boolean

Indicates whether the notification step is active.

data.template.steps.filters

object[]

Filters applied to this notification step.

Show child attributes

data.template.steps.filters.children

object[]

required

Show child attributes

data.template.steps.filters.isNegated

boolean

required

data.template.steps.filters.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

data.template.steps.filters.value

enum<string>

required

Available options:

AND,

OR

data.template.steps.metadata

object

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

• Option 1
• Option 2
• Option 3
• Option 4

Show child attributes

data.template.steps.metadata.type

enum<string>

required

Available options:

regular,

backoff

data.template.steps.metadata.amount

number

data.template.steps.metadata.backoff

boolean

data.template.steps.metadata.backoffAmount

number

data.template.steps.metadata.backoffUnit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

data.template.steps.metadata.digestKey

string

data.template.steps.metadata.unit

enum<string>

Available options:

seconds,

minutes,

hours,

days,

weeks,

months

data.template.steps.metadata.updateMode

boolean

data.template.steps.name

string

Name of the notification step.

data.template.steps.replyCallback

object

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

Show child attributes

data.template.steps.replyCallback.active

boolean

Indicates whether the reply callback is active.

data.template.steps.replyCallback.url

string

The URL to which replies should be sent.

data.template.steps.shouldStopOnFail

boolean

Determines if the process should stop on failure.

data.template.steps.template

object

Message template used in this notification step.

data.template.steps.uuid

string

Universally unique identifier for the notification step.

data.template.steps.variants

object[]

Show child attributes

data.template.steps.variants._id

string

Unique identifier for the notification step.

data.template.steps.variants._parentId

string

ID of the parent notification step, if applicable.

data.template.steps.variants._templateId

string

ID of the template associated with this notification step.

data.template.steps.variants.active

boolean

Indicates whether the notification step is active.

data.template.steps.variants.filters

object[]

Filters applied to this notification step.

Show child attributes

data.template.steps.variants.metadata

object

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

• Option 1
• Option 2
• Option 3
• Option 4

Show child attributes

data.template.steps.variants.name

string

Name of the notification step.

data.template.steps.variants.replyCallback

object

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

Show child attributes

data.template.steps.variants.shouldStopOnFail

boolean

Determines if the process should stop on failure.

data.template.steps.variants.template

object

Message template used in this notification step.

data.template.steps.variants.uuid

string

Universally unique identifier for the notification step.

data.template.tags

string[]

required

data.template.triggers

object[]

required

Show child attributes

data.template.triggers.identifier

string

required

data.template.triggers.type

enum<string>

required

Available options:

event

data.template.triggers.variables

object[]

required

Show child attributes

data.template.triggers.variables.name

string

required

Name of the variable

data.template.triggers.subscriberVariables

object[]

Show child attributes

data.template.triggers.subscriberVariables.name

string

required

Name of the variable

data.template._id

string

data.template._parentId

string

data.template.data

object

data.template.notificationGroup

object

Show child attributes

data.template.notificationGroup._environmentId

string

required

data.template.notificationGroup._organizationId

string

required

data.template.notificationGroup.name

string

required

data.template.notificationGroup._id

string

data.template.notificationGroup._parentId

string

data.template.workflowIntegrationStatus

object

data.templateIdentifier

string

Identifier for the message template

data.title

string

Title of the message, if applicable