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 20 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.2.0, at version 3.15.0.
Requests are made against 2 base URLs: https://api.novu.co, https://eu.api.novu.co.
35 operations30 paths91 schemas3 DELETE8 GET13 PATCH10 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
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…
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.
ReplyCallback
object
2 properties
PatchPreferenceChannelsDto
object
5 properties
EmailBlock
object
4 properties2 required
MessageActionResult
object
2 properties
TimeRangeDto
object
2 properties2 required
BulkCreateSubscriberResponseDto
object
3 properties3 required
NotificationTrigger
object
4 properties3 required
MarkAllMessageAsRequestDto
object
2 properties1 required
BulkUpdateSubscriberPreferenceItemDto
object
2 properties2 required
FeedResponseDto
object
5 properties4 required
SubscriberGlobalPreferenceDto
object
3 properties2 required
UpdatedSubscriberDto
object
1 property1 required
ConstraintValidation
object
2 properties1 required
MessageButton
object
3 properties2 required
ChannelTypeEnum
string
Channel type through which the message is sent
CreatedSubscriberDto
object
1 property1 required
ListSubscribersResponseDto
object
5 properties5 required
TopicResponseDto
object
5 properties2 required
MessageStatusEnum
string
Status of the message
FailedOperationDto
object
2 properties
ScheduleDto
object
2 properties1 required
FieldFilterPartDto
object
4 properties4 required
NotificationStepDto
object
12 properties
BulkUpdateSubscriberPreferencesDto
object
2 properties1 required
MessageCTA
object
3 properties
EmailBlockStyles
object
1 property1 required
UpdateSubscriberOnlineFlagRequestDto
object
1 property1 required
GetSubscriberNotificationsResponseDto
object
3 properties3 required
UnseenCountResponse
object
1 property1 required
MessageAction
object
3 properties
GetPreferencesResponseDto
object
5 properties3 required
NotificationWorkflowDto
object
7 properties5 required
WorkflowResponse
object
21 properties16 required
StepFilterDto
object
4 properties4 required
EmailBlockTypeEnum
string
Type of the email block
TimedConfig
object
6 properties
WorkflowDto
object
7 properties5 required
SeverityLevelEnum
string
Severity of the workflow
MessageMarkAsRequestDto
object
2 properties2 required
DelayScheduledMetadata
object
2 properties2 required
WeeklyScheduleDto
object
7 properties
PreferenceOverrideSourceEnum
string
The source of overrides
DigestTimedMetadata
object
5 properties1 required
MarkMessageActionAsSeenDto
object
2 properties1 required
MessageCTAData
object
1 property
TopicSubscriptionResponseDto
object
6 properties5 required
SubscriberPreferenceChannels
object
5 properties
BulkSubscriberCreateDto
object
1 property1 required
CreateSubscriberRequestDto
object
9 properties1 required
RemoveSubscriberResponseDto
object
2 properties2 required
SubscriberDto
object
6 properties2 required
DelayRegularMetadata
object
3 properties1 required
GetSubscriberNotificationsCountResponseDto
object
2 properties2 required
MarkSubscriberNotificationsAsSeenDto
object
4 properties
ErrorDto
object
6 properties3 required
RedirectDto
object
2 properties1 required
InboxActionDto
object
3 properties2 required
ButtonTypeEnum
string
Type of button for the action result
ActorFeedItemDto
object
2 properties2 required
NotificationTriggerVariable
object
1 property1 required
ChannelCredentials
object
8 properties
UpdateAllSubscriberNotificationsDto
object
3 properties
SubscriberWorkflowPreferenceDto
object
5 properties4 required
TextAlignEnum
string
Text alignment for the email block
SnoozeSubscriberNotificationDto
object
1 property1 required
MessageTemplate
object
MessageResponseDto
object
35 properties11 required
NotificationFeedItemDto
object
29 properties15 required
DigestRegularMetadata
object
8 properties1 required
ListTopicSubscriptionsResponseDto
object
5 properties5 required
InboxNotificationDto
object
24 properties11 required
ChatOrPushProviderEnum
string
The provider identifier for the credentials
DayScheduleDto
object
2 properties1 required
SubscriberFeedResponseDto
object
5 properties1 required
ActorTypeEnum
string
The type of the actor, indicating the role in the notification process.
PreferenceLevelEnum
string
The level of the preference (global or template)
GetSubscriberPreferencesDto
object
2 properties2 required
SubscriberResponseDto
object
20 properties6 required
SubscriberPreferencesWorkflowInfoDto
object
4 properties3 required
BuilderFieldTypeEnum
string
MessageActionStatusEnum
string
Status of the message action
PatchSubscriberRequestDto
object
8 properties
NotificationStepData
object
11 properties
ValidationErrorDto
object
7 properties4 required
SubscriberPreferenceOverrideDto
object
2 properties2 required
ChannelSettingsDto
object
4 properties3 required
NotificationGroup
object
5 properties3 required
PatchSubscriberPreferencesDto
object
4 properties
InboxSubscriberResponseDto
object
5 properties2 required
UpdateSubscriberChannelRequestDto
object
3 properties2 required
ChannelCTATypeEnum
string
Type of call to action
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Novu Subscribers API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
