SubscriberResponseDto.md

SubscriberResponseDto

Fields

Field	Type	Required	Description
id	Optional<String>	➖	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.
firstName	JsonNullable<String>	➖	The first name of the subscriber.
lastName	JsonNullable<String>	➖	The last name of the subscriber.
email	JsonNullable<String>	➖	The email address of the subscriber.
phone	JsonNullable<String>	➖	The phone number of the subscriber.
avatar	JsonNullable<String>	➖	The URL of the subscriber's avatar image.
locale	JsonNullable<String>	➖	The locale setting of the subscriber, indicating their preferred language or region.
channels	List<ChannelSettingsDto>	➖	An array of channel settings associated with the subscriber.
topics	List<String>	➖	: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. An array of topics that the subscriber is subscribed to.
isOnline	JsonNullable<Boolean>	➖	Indicates whether the subscriber is currently online.
lastOnlineAt	JsonNullable<String>	➖	The timestamp indicating when the subscriber was last online, in ISO 8601 format.
v	Optional<Double>	➖	The version of the subscriber document.
data	Map<String, Object>	➖	Additional custom data for the subscriber
timezone	JsonNullable<String>	➖	Timezone of the subscriber
subscriberId	String	✔️	The identifier used to create this subscriber, which typically corresponds to the user ID in your system.
organizationId	String	✔️	The unique identifier of the organization to which the subscriber belongs.
environmentId	String	✔️	The unique identifier of the environment associated with this subscriber.
deleted	boolean	✔️	Indicates whether the subscriber has been deleted.
createdAt	String	✔️	The timestamp indicating when the subscriber was created, in ISO 8601 format.
updatedAt	String	✔️	The timestamp indicating when the subscriber was last updated, in ISO 8601 format.