Create subscriber

POST

subscribers

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Authorizations

Authorization

string

headerrequired

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Body

application/json

subscriberId

string

required

The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems

string

The email address of the subscriber.

firstName

string

The first name of the subscriber.

lastName

string

The last name of the subscriber.

phone

string

The phone number of the subscriber.

avatar

string

An HTTP URL to the profile image of your subscriber.

locale

string

The locale of the subscriber.

data

object

An optional payload object that can contain any properties.

channels

object[]

An optional array of subscriber channels.

Response

201 - application/json

data

object

data.subscriberId

string

required

The identifier used to create this subscriber, which typically corresponds to the user ID in your system.

data._organizationId

string

required

The unique identifier of the organization to which the subscriber belongs.

data._environmentId

string

required

The unique identifier of the environment associated with this subscriber.

data.deleted

boolean

required

Indicates whether the subscriber has been deleted.

data.createdAt

string

required

The timestamp indicating when the subscriber was created, in ISO 8601 format.

data.updatedAt

string

required

The timestamp indicating when the subscriber was last updated, in ISO 8601 format.

data._id

string

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.

data.firstName

string

The first name of the subscriber.

data.lastName

string

The last name of the subscriber.

data.email

string

The email address of the subscriber.

data.phone

string

The phone number of the subscriber.

data.avatar

string

The URL of the subscriber's avatar image.

data.locale

string

The locale setting of the subscriber, indicating their preferred language or region.

data.channels

object[]

An array of channel settings associated with the subscriber.

data.topics

string[]

An array of topics that the subscriber is subscribed to.

data.isOnline

boolean

Indicates whether the subscriber is currently online.

data.lastOnlineAt

string

The timestamp indicating when the subscriber was last online, in ISO 8601 format.

data.__v

number

The version of the subscriber document.

Was this page helpful?

Suggest edits Raise issue

Get subscribers Bulk create subscribers

API Reference

Authorizations

Body

Response