> ## Documentation Index
> Fetch the complete documentation index at: https://v0.x-docs.novu.co/llms.txt
> Use this file to discover all available pages before exploring further.
# Update subscriber
> Used to update the subscriber entity with new information
Enter your API key in the `Authorization` field like the example shown below:
E.g `ApiKey 18d2e625f05d80e`
```java Java theme={null}
import co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.SingleSubscriberResponse;
import co.novu.api.subscribers.requests.UpdateSubscriberRequest;
public class Main {
public static void main(String[] args) {
String apiKey = "";
Novu novu = new Novu(apiKey);
String subscriberId = "";
UpdateSubscriberRequest updateSubscriberRequest = new UpdateSubscriberRequest();
updateSubscriberRequest.setEmail("");
updateSubscriberRequest.setFirstName("");
updateSubscriberRequest.setLastName("");
updateSubscriberRequest.setPhone("");
SingleSubscriberResponse response = novu.updateSubscriber(updateSubscriberRequest, subscriberId);
}
}
```
```json Response theme={null}
{
"data": {
"__v": "number",
"_environmentId": "string",
"_id": "string",
"_organizationId": "string",
"avatar": "string",
"channels": [
{
"_integrationId": "string",
"credentials": {
"channel": "string",
"deviceTokens": [
"string"
],
"webhookUrl": "string"
},
"integrationIdentifier": "string",
"providerId": "slack"
}
],
"createdAt": "string",
"deleted": "boolean",
"email": "string",
"firstName": "string",
"isOnline": "boolean",
"lastName": "string",
"lastOnlineAt": "string",
"locale": "string",
"phone": "string",
"subscriberId": "string",
"updatedAt": "string"
}
}
```
## OpenAPI
````yaml put /v1/subscribers/{subscriberId}
openapi: 3.0.0
info:
title: Novu API
description: >-
Novu REST API. Please see https://docs.novu.co/api-reference for more
details.
version: '1.0'
contact:
name: Novu Support
url: https://discord.gg/novu
email: support@novu.co
termsOfService: https://novu.co/terms
license:
name: MIT
url: https://opensource.org/license/mit
servers:
- url: https://api.novu.co
- url: https://eu.api.novu.co
security: []
tags:
- name: Events
description: >-
Events represent a change in state of a subscriber. They are used to
trigger workflows, and enable you to send notifications to subscribers
based on their actions.
externalDocs:
url: https://docs.novu.co/workflows
- name: Subscribers
description: >-
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.
externalDocs:
url: https://docs.novu.co/subscribers/subscribers
- name: Topics
description: >-
Topics are a way to group subscribers together so that they can be
notified of events at once. A topic is identified by a custom key. This
can be helpful for things like sending out marketing emails or notifying
users of new features. Topics can also be used to send notifications to
the subscribers who have been grouped together based on their interests,
location, activities and much more.
externalDocs:
url: https://docs.novu.co/subscribers/topics
- name: Notification
description: >-
A notification conveys information from source to recipient, triggered by
a workflow acting as a message blueprint. Notifications can be individual
or bundled as digest for user-friendliness.
externalDocs:
url: https://docs.novu.co/getting-started/introduction
- name: Integrations
description: >-
With the help of the Integration Store, you can easily integrate your
favorite delivery provider. During the runtime of the API, the
Integrations Store is responsible for storing the configurations of all
the providers.
externalDocs:
url: https://docs.novu.co/channels-and-providers/integration-store
- name: Layouts
description: >-
Novu allows the creation of layouts - a specific HTML design or structure
to wrap content of email notifications. Layouts can be manipulated and
assigned to new or existing workflows within the Novu platform, allowing
users to create, manage, and assign these layouts to workflows, so they
can be reused to structure the appearance of notifications sent through
the platform.
externalDocs:
url: https://docs.novu.co/content-creation-design/layouts
- name: Workflows
description: >-
All notifications are sent via a workflow. Each workflow acts as a
container for the logic and blueprint that are associated with a type of
notification in your system.
externalDocs:
url: https://docs.novu.co/workflows
- name: Notification Templates
description: >-
Deprecated. Use Workflows (/workflows) instead, which provide the same
functionality under a new name.
- name: Workflow groups
description: Workflow groups are used to organize workflows into logical groups.
- name: Changes
description: >-
Changes represent a change in state of an environment. They are analagous
to a pending pull request in git, enabling you to test changes before they
are applied to your environment and atomically apply them when you are
ready.
externalDocs:
url: >-
https://docs.novu.co/platform/environments#promoting-pending-changes-to-production
- name: Environments
description: >-
Novu uses the concept of environments to ensure logical separation of your
data and configuration. This means that subscribers, and preferences
created in one environment are never accessible to another.
externalDocs:
url: https://docs.novu.co/platform/environments
- name: Inbound Parse
description: >-
Inbound Webhook is a feature that allows processing of incoming emails for
a domain or subdomain. The feature parses the contents of the email and
POSTs the information to a specified URL in a multipart/form-data format.
externalDocs:
url: https://docs.novu.co/platform/inbound-parse-webhook
- name: Feeds
description: >-
Novu provides a notification activity feed that monitors every outgoing
message associated with its relevant metadata. This can be used to monitor
activity and discover potential issues with a specific provider or a
channel type.
externalDocs:
url: https://docs.novu.co/activity-feed
- name: Tenants
description: >-
A tenant represents a group of users. As a developer, when your apps have
organizations, they are referred to as tenants. Tenants in Novu provides
the ability to tailor specific notification experiences to users of
different groups or organizations.
externalDocs:
url: https://docs.novu.co/tenants
- name: Messages
description: >-
A message in Novu represents a notification delivered to a recipient on a
particular channel. Messages contain information about the request that
triggered its delivery, a view of the data sent to the recipient, and a
timeline of its lifecycle events. Learn more about messages.
externalDocs:
url: https://docs.novu.co/workflows/messages
- name: Organizations
description: >-
An organization serves as a separate entity within your Novu account. Each
organization you create has its own separate integration store, workflows,
subscribers, and API keys. This separation of resources allows you to
manage multi-tenant environments and separate domains within a single
account.
externalDocs:
url: https://docs.novu.co/platform/organizations
- name: Execution Details
description: >-
Execution details are used to track the execution of a workflow. They
provided detailed information on the execution of a workflow, including
the status of each step, the input and output of each step, and the
overall status of the execution.
externalDocs:
url: https://docs.novu.co/activity-feed
externalDocs:
description: Novu Documentation
url: https://docs.novu.co
paths:
/v1/subscribers/{subscriberId}:
put:
tags:
- Subscribers
summary: Update subscriber
description: Used to update the subscriber entity with new information
operationId: SubscribersController_updateSubscriber
parameters:
- name: subscriberId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSubscriberRequestDto'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriberResponseDto'
'409':
description: >-
The request could not be completed due to a conflict with the
current state of the target resource.
content:
application/json:
schema:
type: string
example: >-
Request with key 3909d656-d4fe-4e80-ba86-90d3861afcd7 is
currently being processed. Please retry after 1 second
'429':
description: 'The client has sent too many requests in a given amount of time. '
content:
application/json:
schema:
type: string
example: API rate limit exceeded
'503':
description: >-
The server is currently unable to handle the request due to a
temporary overload or scheduled maintenance, which will likely be
alleviated after some delay.
content:
application/json:
schema:
type: string
example: Please wait some time, then try again.
security:
- api-key: []
x-codeSamples:
- lang: typescript
label: SubscribersController_updateSubscriber
source: |-
import { Novu } from "@novu/api";
const novu = new Novu({
apiKey: "",
});
async function run() {
const result = await novu.subscribers.update("", {});
// Handle the result
console.log(result)
}
run();
components:
schemas:
UpdateSubscriberRequestDto:
type: object
properties:
email:
type: string
firstName:
type: string
lastName:
type: string
phone:
type: string
avatar:
type: string
locale:
type: string
data:
type: object
SubscriberResponseDto:
type: object
properties:
_id:
type: string
description: >-
The internal id novu generated for your subscriber, this is not the
subscriberId matching your query. See `subscriberId` for that
firstName:
type: string
lastName:
type: string
email:
type: string
phone:
type: string
avatar:
type: string
locale:
type: string
subscriberId:
type: string
description: >-
The internal identifier you used to create this subscriber, usually
correlates to the id the user in your systems
channels:
description: Channels settings for subscriber
type: array
items:
$ref: '#/components/schemas/ChannelSettings'
isOnline:
type: boolean
lastOnlineAt:
type: string
_organizationId:
type: string
_environmentId:
type: string
deleted:
type: boolean
createdAt:
type: string
updatedAt:
type: string
__v:
type: number
required:
- subscriberId
- _organizationId
- _environmentId
- deleted
- createdAt
- updatedAt
ChannelSettings:
type: object
properties:
providerId:
type: string
enum:
- slack
- discord
- msteams
- mattermost
- ryver
- zulip
- grafana-on-call
- getstream
- rocket-chat
- whatsapp-business
- fcm
- apns
- expo
- one-signal
- pushpad
- push-webhook
- pusher-beams
description: The provider identifier for the credentials
integrationIdentifier:
type: string
description: The integration identifier
credentials:
description: Credentials payload for the specified provider
allOf:
- $ref: '#/components/schemas/ChannelCredentials'
_integrationId:
type: string
description: Id of the integration that is used for this channel
required:
- providerId
- credentials
- _integrationId
ChannelCredentials:
type: object
properties:
webhookUrl:
type: string
description: >-
Webhook url used by chat app integrations. The webhook should be
obtained from the chat app provider.
channel:
type: string
description: Channel specification for Mattermost chat notifications
deviceTokens:
description: >-
Contains an array of the subscriber device tokens for a given
provider. Used on Push integrations
type: array
items:
type: string
alertUid:
type: string
description: alert_uid for grafana on-call webhook payload
title:
type: string
description: title to be used with grafana on call webhook
imageUrl:
type: string
description: image_url property fo grafana on call webhook
state:
type: string
description: state property fo grafana on call webhook
externalUrl:
type: string
description: link_to_upstream_details property fo grafana on call webhook
required:
- webhookUrl
securitySchemes:
api-key:
type: apiKey
in: header
name: Authorization
description: >-
API key authentication. Allowed headers-- "Authorization: ApiKey
".
````