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

cURL

curl --location 'https://api.novu.co/v1/subscribers' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: ApiKey <NOVU_SECRET_KEY>' \
  --data-raw '{
    "firstName": "Pawan",
    "lastName": "Jain",
    "email": "[e-mail]",
    "phone": "[phone]",
    "avatar": "avatar-url",
    "locale": "en-US",
    "data": {
      "isDeveloper": true,
      "customKey": "customValue"
      }
    }'

Response

{
  "data": {
    "_organizationId": "abcd12349876wxyz1234wxyz",
    "_environmentId": "zyxw4321abcd1234lmno5678",
    "firstName": "Alex",
    "lastName": "Benjamin",
    "phone": "123456789",
    "subscriberId": "abcd1234",
    "email": "[e-mail]",
    "avatar": "string",
    "locale": "en-US",
    "channels": [],
    "_id": "6516ed5a9d727fe8256028ed",
    "deleted": false,
    "createdAt": "2023-09-29T15:29:30.667Z",
    "updatedAt": "2023-09-29T15:29:30.667Z",
    "__v": 0,
    "id": "6516ed5a9d727fe8256028ed"
  }
}

Authorizations

Authorization · string · header · required

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

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.

Show child attributes

channels · object[]

An optional array of subscriber channels.

Show child attributes

Response

201

application/json

Created

data · object

Show child attributes