| Field | Type | Required | Description |
|---|---|---|---|
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 |
bool | ✔️ | 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. |
id |
?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 |
?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 | ➖ | The URL of the subscriber's avatar image. |
locale |
?string | ➖ | The locale setting of the subscriber, indicating their preferred language or region. |
channels |
array<Components\ChannelSettingsDto> | ➖ | An array of channel settings associated with the subscriber. |
topics |
array<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 |
?bool | ➖ | Indicates whether the subscriber is currently online. |
lastOnlineAt |
?string | ➖ | The timestamp indicating when the subscriber was last online, in ISO 8601 format. |
v |
?float | ➖ | The version of the subscriber document. |
timezone |
?string | ➖ | Timezone of the subscriber |
email |
?string | ➖ | The email address of the subscriber. |
data |
array<string, mixed> | ➖ | Additional custom data for the subscriber |