Novu · Schema

CreateSubscriberRequestDto

JSON Schema for Novu CreateSubscriberRequestDto.

NotificationsMessagingIn AppEmailSMSPushChatWorkflowsOpen SourceSubscribersTopicsInboxWorkflow OrchestrationMulti ChannelDigestMCPFrameworkReact

Properties

Name	Type	Description
firstName	stringnull	First name of the subscriber
lastName	stringnull	Last name of the subscriber
email	stringnull	Email address of the subscriber
phone	stringnull	Phone number of the subscriber
avatar	stringnull	Avatar URL or identifier
locale	stringnull	Locale of the subscriber
timezone	stringnull	Timezone of the subscriber
data	objectnull	Additional custom data associated with the subscriber
subscriberId	string	Unique identifier of the subscriber

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/novu/main/json-schema/novu-create-subscriber-request-dto-schema.json",
  "title": "CreateSubscriberRequestDto",
  "description": "JSON Schema for Novu CreateSubscriberRequestDto.",
  "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": "[email protected]"
    },
    "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"
  ]
}