Skip to main content

Create a notification subscriber

POST 
/api/v1/notifications/manage/create-subscriber

Creates a new subscriber profile in the notification system. The subscriber ID is used to target notifications and manage preferences.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Welcome a new user with an in-app message

Request​

Responses​

Subscriber created

Enroll an application user for notification delivery; use their stable application user ID.​

Section ID: DOC-CP-notifications-api-createSubscriber#example-notifications-createSubscriber-request

Request example

{
  "subscriberId": "user-1",
  "email": "alex@example.com",
  "firstName": "Alex",
  "locale": "en-US"
}

Guide request for 2. Enroll the same application user. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-notifications-api-createSubscriber#example-cookbook-core-platform-notifications-administration-json-02-request

Request example

{
  "subscriberId": "user-1"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-notifications-api-createSubscriber#example-notifications-createSubscriber-response

Response example

{
  "novuSubscriberId": "example_123",
  "subscriberId": "example_123"
}

Document ID: DOC-CP-notifications-api-createSubscriber. Section identities and revisions.

SectionStable reference
Create a notification subscriberDOC-CP-notifications-api-createSubscriber#overview
RequestDOC-CP-notifications-api-createSubscriber#request
ResponsesDOC-CP-notifications-api-createSubscriber#responses