API Reference
Subscribers
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate provider credentials
- DELDelete provider credentials
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber global preferences
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preferences
- GETRetrieve subscriber notifications
- GETRetrieve unseen notifications count
- POSTMark a subscriber feed message as seen
- POSTUpdate all notifications state
- POSTUpdate notification action status
- GETHandle providers oauth redirect
- GETHandle chat oauth
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Organizations
Subscribers
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.
POST
/
v1
/
subscribers
curl --location 'https://api.novu.co/v1/subscribers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: ApiKey <NOVU_API_KEY>' \
--data-raw '{
"firstName": "Pawan",
"lastName": "Jain",
"email": "pawan.jain@domain.com",
"phone": "+1234567890",
"avatar": "avatar-url",
"locale": "en-US",
"data": {
"isDeveloper": true,
"customKey": "customValue"
}
}'
{
"data": {
"_organizationId": "abcd12349876wxyz1234wxyz",
"_environmentId": "zyxw4321abcd1234lmno5678",
"firstName": "Alex",
"lastName": "Benjamin",
"phone": "123456789",
"subscriberId": "abcd1234",
"email": "alex@email.com",
"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"
}
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
curl --location 'https://api.novu.co/v1/subscribers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: ApiKey <NOVU_API_KEY>' \
--data-raw '{
"firstName": "Pawan",
"lastName": "Jain",
"email": "pawan.jain@domain.com",
"phone": "+1234567890",
"avatar": "avatar-url",
"locale": "en-US",
"data": {
"isDeveloper": true,
"customKey": "customValue"
}
}'
{
"data": {
"_organizationId": "abcd12349876wxyz1234wxyz",
"_environmentId": "zyxw4321abcd1234lmno5678",
"firstName": "Alex",
"lastName": "Benjamin",
"phone": "123456789",
"subscriberId": "abcd1234",
"email": "alex@email.com",
"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
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Body
application/json
Response
201
application/json
Created
The response is of type object
.
Was this page helpful?
curl --location 'https://api.novu.co/v1/subscribers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: ApiKey <NOVU_API_KEY>' \
--data-raw '{
"firstName": "Pawan",
"lastName": "Jain",
"email": "pawan.jain@domain.com",
"phone": "+1234567890",
"avatar": "avatar-url",
"locale": "en-US",
"data": {
"isDeveloper": true,
"customKey": "customValue"
}
}'
{
"data": {
"_organizationId": "abcd12349876wxyz1234wxyz",
"_environmentId": "zyxw4321abcd1234lmno5678",
"firstName": "Alex",
"lastName": "Benjamin",
"phone": "123456789",
"subscriberId": "abcd1234",
"email": "alex@email.com",
"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"
}
}
Assistant
Responses are generated using AI and may contain mistakes.