Create subscriber

Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.

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

email

string

firstName

string

lastName

string

phone

string

avatar

string

An http url to the profile image of your subscriber

locale

string

data

object

channels

object[]

Show child attributes

Response

201 - application/json

data

object

Show child attributes