Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 5.22 KB

createsubscriberrequestdto.md

File metadata and controls

25 lines (20 loc) · 5.22 KB

CreateSubscriberRequestDto

Example Usage

import { CreateSubscriberRequestDto } from "@novu/api/models/components";

let value: CreateSubscriberRequestDto = {
  subscriberId: "<id>",
};

Fields

Field Type Required Description
subscriberId string ✔️ 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 Record<string, components.CreateSubscriberRequestDtoData> An optional payload object that can contain any properties.
channels components.SubscriberChannelDto[] An optional array of subscriber channels.