Sign in

v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB
Subscribers

Update notifications state

This API is deprecated, use v2 API instead. Update subscriber's multiple in-app notifications state such as seen, read, unseen or unread by subscriberId. messageId is of type mongodbId of notifications.

post/v1/subscribers/{subscriberId}/messages/mark-as

Path parameters

subscriberIdstring required

Headers

idempotency-keystring

A header for idempotency purposes

Request body

markAs'read' | 'seen' | 'unread' | 'unseen' required

Response

Created

_idstring

Unique identifier for the message

_templateIdstring nullable

Template ID associated with the message

_environmentIdstring required

Environment ID where the message is sent

_messageTemplateIdstring nullable

Message template ID

_organizationIdstring required

Organization ID associated with the message

_notificationIdstring required

Notification ID associated with the message

_subscriberIdstring required

Subscriber ID associated with the message

templateIdentifierstring

Identifier for the message template

createdAtstring required

Creation date of the message

deliveredAtstring[]

Array of delivery dates for the message, if the message has multiple delivery dates, for example after being snoozed

lastSeenDatestring

Last seen date of the message, if available

lastReadDatestring

Last read date of the message, if available

transactionIdstring required

Transaction ID associated with the message

subjectstring

Subject of the message, if applicable

channel'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool' required

Channel type through which the message is sent

readboolean required

Indicates if the message has been read

seenboolean required

Indicates if the message has been seen

snoozedUntilstring

Date when the message will be unsnoozed

emailstring

Email address associated with the message, if applicable

phonestring

Phone number associated with the message, if applicable

directWebhookUrlstring

Direct webhook URL for the message, if applicable

providerIdstring

Provider ID associated with the message, if applicable

deviceTokensstring[]

Device tokens associated with the message, if applicable

titlestring

Title of the message, if applicable

_feedIdstring nullable

Feed ID associated with the message, if applicable

status'sent' | 'error' | 'warning' required

Status of the message

errorIdstring

Error ID if the message has an error

errorTextstring

Error text if the message has an error

payloadobject

The payload that was used to send the notification trigger

overridesobject

Provider specific overrides used when triggering the notification

contextKeysstring[]

Context (single or multi) in which the message was sent