Create a subscriber
Create a subscriber using the Novu REST API. Requires your environment secret key in the Authorization header.
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".
Headers
A header for idempotency purposes
Query Parameters
If true, the request will fail if a subscriber with the same subscriberId already exists
Body
Unique identifier of the subscriber
First name of the subscriber
"John"
Last name of the subscriber
"Doe"
Email address of the subscriber
"john.doe@example.com"
Phone number of the subscriber
"+1234567890"
Avatar URL or identifier
"https://example.com/avatar.jpg"
Locale of the subscriber
"en-US"
Timezone of the subscriber
"America/New_York"
Additional custom data associated with the subscriber
Response
Created
The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
The unique identifier of the organization to which the subscriber belongs.
The unique identifier of the environment associated with this subscriber.
Indicates whether the subscriber has been deleted.
The timestamp indicating when the subscriber was created, in ISO 8601 format.
The timestamp indicating when the subscriber was last updated, in ISO 8601 format.
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.
The first name of the subscriber.
The last name of the subscriber.
The email address of the subscriber.
The phone number of the subscriber.
The URL of the subscriber's avatar image.
The locale setting of the subscriber, indicating their preferred language or region.
An array of channel settings associated with the subscriber.
An array of topics that the subscriber is subscribed to.
Indicates whether the subscriber is currently online.
The timestamp indicating when the subscriber was last online, in ISO 8601 format.
The version of the subscriber document.
Additional custom data for the subscriber
Timezone of the subscriber