Novu · Schema

BulkSubscriberCreateDto

JSON Schema for Novu BulkSubscriberCreateDto.

NotificationMessagingIn-AppEmailSMSPushChatWorkflowsOpen-SourceSubscribersTopicsInboxWorkflow OrchestrationMulti-ChannelDigestMCPFrameworkReact

Properties

Name Type Description
subscribers array An array of subscribers to be created in bulk.
View JSON Schema on GitHub

JSON Schema

novu-bulk-subscriber-create-dto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/novu/main/json-schema/novu-bulk-subscriber-create-dto-schema.json",
  "title": "BulkSubscriberCreateDto",
  "description": "JSON Schema for Novu BulkSubscriberCreateDto.",
  "type": "object",
  "properties": {
    "subscribers": {
      "description": "An array of subscribers to be created in bulk.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "firstName": {
            "type": [
              "string",
              "null"
            ],
            "description": "First name of the subscriber",
            "example": "John"
          },
          "lastName": {
            "type": [
              "string",
              "null"
            ],
            "description": "Last name of the subscriber",
            "example": "Doe"
          },
          "email": {
            "type": [
              "string",
              "null"
            ],
            "description": "Email address of the subscriber",
            "example": "john.doe@example.com"
          },
          "phone": {
            "type": [
              "string",
              "null"
            ],
            "description": "Phone number of the subscriber",
            "example": "+1234567890"
          },
          "avatar": {
            "type": [
              "string",
              "null"
            ],
            "description": "Avatar URL or identifier",
            "example": "https://example.com/avatar.jpg"
          },
          "locale": {
            "type": [
              "string",
              "null"
            ],
            "description": "Locale of the subscriber",
            "example": "en-US"
          },
          "timezone": {
            "type": [
              "string",
              "null"
            ],
            "description": "Timezone of the subscriber",
            "example": "America/New_York"
          },
          "data": {
            "type": [
              "object",
              "null"
            ],
            "description": "Additional custom data associated with the subscriber",
            "additionalProperties": true
          },
          "subscriberId": {
            "type": "string",
            "description": "Unique identifier of the subscriber"
          }
        },
        "required": [
          "subscriberId"
        ]
      }
    }
  },
  "required": [
    "subscribers"
  ]
}