Novu Subscribers API
A subscriber in Novu represents someone who should receive a message. A subscriber's profile information contains important attributes about the subscriber that will be used in messages (name, email). The subscriber object can contain other key-value pairs that can be used to further personalize your messages.
Novu Subscribers API is one of 19 APIs that Novu publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 26 JSON Schema definitions.
Tagged areas include Subscribers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, a getting-started guide, and 26 JSON Schemas.
This API exposes 35 operations across 30 paths, and defines 91 schemas. It is described by OpenAPI 3.1.0, at version 3.15.0.
Requests are made against 2 base URLs: https://api.novu.co, https://eu.api.novu.co.
35 operations
30 paths
91 schemas
3 DELETE8 GET13 PATCH10 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Novu Subscribers API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (secretKey).
By default, every request must be authenticated.
secretKey— API key authentication. Allowed headers-- "Authorization: ApiKey ".
Paths & Operations 35
Across 30 paths, the API surfaces 35 operations — 3 DELETE, 8 GET, 13 PATCH, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Subscribers 35
A subscriber in Novu represents someone who should receive a message. A subscriber's profile information contains important attributes about the subscriber that will be used in me…
POST
/v1/subscribers/bulk
Novu Bulk Create Subscribers
PUT
/v1/subscribers/{subscriberId}/credentials
Novu Update Provider Credentials
PATCH
/v1/subscribers/{subscriberId}/credentials
Novu Upsert Provider Credentials
DELETE
/v1/subscribers/{subscriberId}/credentials/{providerId}
Novu Delete Provider Credentials
PATCH
/v1/subscribers/{subscriberId}/online-status
Novu Update Subscriber Online Status
GET
/v1/subscribers/{subscriberId}/notifications/feed
Novu Retrieve Subscriber Notifications
GET
/v1/subscribers/{subscriberId}/notifications/unseen
Novu Retrieve Unseen Notifications Count
POST
/v1/subscribers/{subscriberId}/messages/mark-as
Novu Update Notifications State
POST
/v1/subscribers/{subscriberId}/messages/mark-all
Novu Update All Notifications State
POST
/v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}
Novu Update Notification Action Status
GET
/v2/subscribers
Novu Search Subscribers
POST
/v2/subscribers
Novu Create a Subscriber
GET
/v2/subscribers/{subscriberId}
Novu Retrieve a Subscriber
PATCH
/v2/subscribers/{subscriberId}
Novu Update a Subscriber
DELETE
/v2/subscribers/{subscriberId}
Novu Delete a Subscriber
GET
/v2/subscribers/{subscriberId}/preferences
Novu Retrieve Subscriber Preferences
PATCH
/v2/subscribers/{subscriberId}/preferences
Novu Update Subscriber Preferences
PATCH
/v2/subscribers/{subscriberId}/preferences/bulk
Novu Bulk Update Subscriber Preferences
GET
/v2/subscribers/{subscriberId}/subscriptions
Novu Retrieve Subscriber Subscriptions
GET
/v2/subscribers/{subscriberId}/notifications
Novu Retrieve Subscriber Notifications
GET
/v2/subscribers/{subscriberId}/notifications/count
Novu Retrieve Subscriber Notifications Count
PATCH
/v2/subscribers/{subscriberId}/notifications/{notificationId}/read
Novu Mark a Notification as Read
PATCH
/v2/subscribers/{subscriberId}/notifications/{notificationId}/unread
Novu Mark a Notification as Unread
PATCH
/v2/subscribers/{subscriberId}/notifications/{notificationId}/archive
Novu Archive a Notification
PATCH
/v2/subscribers/{subscriberId}/notifications/{notificationId}/unarchive
Novu Unarchive a Notification
PATCH
/v2/subscribers/{subscriberId}/notifications/{notificationId}/snooze
Novu Snooze a Notification
PATCH
/v2/subscribers/{subscriberId}/notifications/{notificationId}/unsnooze
Novu Unsnooze a Notification
DELETE
/v2/subscribers/{subscriberId}/notifications/{notificationId}
Novu Delete a Notification
PATCH
/v2/subscribers/{subscriberId}/notifications/{notificationId}/actions/{actionType}/complete
Novu Complete a Notification Action
PATCH
/v2/subscribers/{subscriberId}/notifications/{notificationId}/actions/{actionType}/revert
Novu Revert a Notification Action
POST
/v2/subscribers/{subscriberId}/notifications/seen
Novu Mark Notifications as Seen
POST
/v2/subscribers/{subscriberId}/notifications/read
Novu Mark All Notifications as Read
POST
/v2/subscribers/{subscriberId}/notifications/archive
Novu Archive All Notifications
POST
/v2/subscribers/{subscriberId}/notifications/read-archive
Novu Archive All Read Notifications
POST
/v2/subscribers/{subscriberId}/notifications/delete
Novu Delete All Notifications
Schemas 91
The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are MessageResponseDto (35 properties), NotificationFeedItemDto (29 properties), InboxNotificationDto (24 properties), WorkflowResponse (21 properties). Each schema is shown below with its type and property counts.
ListTopicSubscriptionsResponseDto
object
5 properties
5 required
EmailBlockTypeEnum
string
Type of the email block
GetSubscriberPreferencesDto
object
2 properties
2 required
DelayScheduledMetadata
object
2 properties
2 required
CreatedSubscriberDto
object
1 property
1 required
RemoveSubscriberResponseDto
object
2 properties
2 required
BulkUpdateSubscriberPreferencesDto
object
2 properties
1 required
InboxSubscriberResponseDto
object
5 properties
2 required
ActorTypeEnum
string
The type of the actor, indicating the role in the notification process.
TimeRangeDto
object
2 properties
2 required
MessageStatusEnum
string
Status of the message
SubscriberGlobalPreferenceDto
object
3 properties
2 required
ActorFeedItemDto
object
2 properties
2 required
TopicSubscriptionResponseDto
object
6 properties
5 required
BulkSubscriberCreateDto
object
1 property
1 required
WeeklyScheduleDto
object
7 properties
ValidationErrorDto
object
7 properties
4 required
SubscriberDto
object
6 properties
2 required
MessageCTAData
object
1 property
PreferenceLevelEnum
string
The level of the preference (global or template)
GetSubscriberNotificationsCountResponseDto
object
2 properties
2 required
ChannelTypeEnum
string
Channel type through which the message is sent
BuilderFieldTypeEnum
string
ChatOrPushProviderEnum
string
The provider identifier for the credentials
TextAlignEnum
string
Text alignment for the email block
DigestTimedMetadata
object
5 properties
1 required
ChannelCredentials
object
8 properties
MessageCTA
object
3 properties
WorkflowDto
object
7 properties
5 required
MessageMarkAsRequestDto
object
2 properties
2 required
GetSubscriberNotificationsResponseDto
object
3 properties
3 required
SubscriberFeedResponseDto
object
5 properties
1 required
SubscriberPreferencesWorkflowInfoDto
object
4 properties
3 required
MessageButton
object
3 properties
2 required
WorkflowResponse
object
21 properties
16 required
DigestRegularMetadata
object
8 properties
1 required
UpdateSubscriberOnlineFlagRequestDto
object
1 property
1 required
ChannelCTATypeEnum
string
Type of call to action
MessageResponseDto
object
35 properties
11 required
DayScheduleDto
object
2 properties
1 required
PatchPreferenceChannelsDto
object
5 properties
NotificationWorkflowDto
object
7 properties
5 required
UpdatedSubscriberDto
object
1 property
1 required
TopicResponseDto
object
5 properties
2 required
MessageAction
object
3 properties
NotificationTriggerVariable
object
1 property
1 required
SnoozeSubscriberNotificationDto
object
1 property
1 required
ChannelSettingsDto
object
4 properties
3 required
SubscriberResponseDto
object
20 properties
6 required
GetPreferencesResponseDto
object
5 properties
3 required
PatchSubscriberPreferencesDto
object
4 properties
ReplyCallback
object
2 properties
MessageActionStatusEnum
string
Status of the message action
ConstraintValidation
object
2 properties
1 required
MarkAllMessageAsRequestDto
object
2 properties
1 required
FieldFilterPartDto
object
4 properties
4 required
NotificationStepDto
object
12 properties
ErrorDto
object
6 properties
3 required
UpdateAllSubscriberNotificationsDto
object
3 properties
PreferenceOverrideSourceEnum
string
The source of overrides
NotificationStepData
object
11 properties
StepFilterDto
object
4 properties
4 required
FeedResponseDto
object
5 properties
4 required
ScheduleDto
object
2 properties
1 required
NotificationGroup
object
5 properties
3 required
EmailBlockStyles
object
1 property
1 required
InboxNotificationDto
object
24 properties
11 required
SubscriberPreferenceOverrideDto
object
2 properties
2 required
RedirectDto
object
2 properties
1 required
MessageActionResult
object
2 properties
NotificationFeedItemDto
object
29 properties
15 required
SubscriberWorkflowPreferenceDto
object
5 properties
4 required
SeverityLevelEnum
string
Severity of the workflow
BulkUpdateSubscriberPreferenceItemDto
object
2 properties
2 required
CreateSubscriberRequestDto
object
9 properties
1 required
EmailBlock
object
4 properties
2 required
PatchSubscriberRequestDto
object
8 properties
ButtonTypeEnum
string
Type of button for the action result
InboxActionDto
object
3 properties
2 required
BulkCreateSubscriberResponseDto
object
3 properties
3 required
ListSubscribersResponseDto
object
5 properties
5 required
SubscriberPreferenceChannels
object
5 properties
UnseenCountResponse
object
1 property
1 required
MarkSubscriberNotificationsAsSeenDto
object
4 properties
UpdateSubscriberChannelRequestDto
object
3 properties
2 required
MarkMessageActionAsSeenDto
object
2 properties
1 required
TimedConfig
object
6 properties
DelayRegularMetadata
object
3 properties
1 required
NotificationTrigger
object
4 properties
3 required
FailedOperationDto
object
2 properties
MessageTemplate
object
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Novu 12
Other APIs Novu publishes across the network.
Novu Inbox / In-App API
Novu Framework (Code-First Workflows)
Novu MCP Server
Novu Activity API
Novu Channel Connections API
Novu Channel Endpoints API
Novu Contexts API
Novu Domains API
Novu Environment Variables API
Novu Environments API
Novu Events API
Novu Integrations API
#Subscribers