Create subscriber
Create subscriber with the given data
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Headers
A header for idempotency purposes
Body
The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems
An HTTP URL to the profile image of your subscriber.
An optional array of subscriber channels.
An optional payload object that can contain any properties.
The email address of the subscriber.
The first name of the subscriber.
The last name of the subscriber.
The locale of the subscriber.
The phone number of the subscriber.
Response
The unique identifier of the environment associated with this subscriber.
The unique identifier of the organization to which the subscriber belongs.
The timestamp indicating when the subscriber was created, in ISO 8601 format.
Indicates whether the subscriber has been deleted.
The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
The timestamp indicating when the subscriber was last updated, in ISO 8601 format.
The version of the subscriber document.
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.
The URL of the subscriber's avatar image.
An array of channel settings associated with the subscriber.
Additional custom data for the subscriber
The email address of the subscriber.
The first name of the subscriber.
Indicates whether the subscriber is currently online.
The last name of the subscriber.
The timestamp indicating when the subscriber was last online, in ISO 8601 format.
The locale setting of the subscriber, indicating their preferred language or region.
The phone number of the subscriber.
Timezone of the subscriber
An array of topics that the subscriber is subscribed to.
Was this page helpful?