{ "$schema": "https://json-structure.org/v0.1/schema", "name": "SubscriberResponseDto", "description": "JSON Schema for Novu SubscriberResponseDto.", "sourceFormat": "OpenAPI 3.x components.schemas", "fields": [ { "name": "_id", "type": "string", "description": "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.", "required": false }, { "name": "firstName", "type": "string", "description": "The first name of the subscriber.", "required": false }, { "name": "lastName", "type": "string", "description": "The last name of the subscriber.", "required": false }, { "name": "email", "type": "string", "description": "The email address of the subscriber.", "required": false }, { "name": "phone", "type": "string", "description": "The phone number of the subscriber.", "required": false }, { "name": "avatar", "type": "string", "description": "The URL of the subscriber's avatar image.", "required": false }, { "name": "locale", "type": "string", "description": "The locale setting of the subscriber, indicating their preferred language or region.", "required": false }, { "name": "channels", "type": "array", "description": "An array of channel settings associated with the subscriber.", "required": false }, { "name": "topics", "type": "array", "description": "An array of topics that the subscriber is subscribed to.", "required": false }, { "name": "isOnline", "type": "boolean", "description": "Indicates whether the subscriber is currently online.", "required": false }, { "name": "lastOnlineAt", "type": "string", "description": "The timestamp indicating when the subscriber was last online, in ISO 8601 format.", "required": false }, { "name": "__v", "type": "number", "description": "The version of the subscriber document.", "required": false }, { "name": "data", "type": "object", "description": "Additional custom data for the subscriber", "required": false }, { "name": "timezone", "type": "string", "description": "Timezone of the subscriber", "required": false }, { "name": "subscriberId", "type": "string", "description": "The identifier used to create this subscriber, which typically corresponds to the user ID in your system.", "required": true }, { "name": "_organizationId", "type": "string", "description": "The unique identifier of the organization to which the subscriber belongs.", "required": true }, { "name": "_environmentId", "type": "string", "description": "The unique identifier of the environment associated with this subscriber.", "required": true }, { "name": "deleted", "type": "boolean", "description": "Indicates whether the subscriber has been deleted.", "required": true }, { "name": "createdAt", "type": "string", "description": "The timestamp indicating when the subscriber was created, in ISO 8601 format.", "required": true }, { "name": "updatedAt", "type": "string", "description": "The timestamp indicating when the subscriber was last updated, in ISO 8601 format.", "required": true } ] }