Novu · Schema

CreateEnvironmentRequestDto

JSON Schema for Novu CreateEnvironmentRequestDto.

NotificationsMessagingIn AppEmailSMSPushChatWorkflowsOpen SourceSubscribersTopicsInboxWorkflow OrchestrationMulti ChannelDigestMCPFrameworkReact

Properties

Name Type Description
name string Name of the environment to be created
parentId string MongoDB ObjectId of the parent environment (optional)
color string Hex color code for the environment
View JSON Schema on GitHub

JSON Schema

novu-create-environment-request-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-create-environment-request-dto-schema.json",
  "title": "CreateEnvironmentRequestDto",
  "description": "JSON Schema for Novu CreateEnvironmentRequestDto.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the environment to be created",
      "example": "Production Environment"
    },
    "parentId": {
      "type": "string",
      "description": "MongoDB ObjectId of the parent environment (optional)",
      "example": "60d5ecb8b3b3a30015f3e1a1"
    },
    "color": {
      "type": "string",
      "description": "Hex color code for the environment",
      "example": "#3498db"
    }
  },
  "required": [
    "name",
    "color"
  ]
}