Tag

Universal tag base entity with properties common to all tag types (CustomerTag, ProductTag, DocumentTag, etc.). Contains tag metadata like name, color, icon, category.

8 properties

Schema

Properties

Property	Type	Mode	Description	Required
name	string	stored	Name or label of the tag Example: `"VIP"`	Required
slug	string	stored	URL-friendly version of the tag name for routing and APIs Example: `"vip"`	Optional
category	string	stored	Category or group for the tag (e.g., 'segment', 'industry', 'priority', 'status') Example: `"segment"`	Optional
description	string	stored	Detailed description of what this tag represents Example: `"Very Important Person - top tier customer"`	Optional
color	string	stored	Color code for visual representation in UI (hex color) Example: `"#8B5CF6"`	Optional
icon	string	stored	Optional icon identifier for the tag Example: `"star"`	Optional
isActive	boolean	stored	Whether this tag is currently active and available for assignment Example: `true`	Optional
sortOrder	number	stored	Display order for sorting tags in UI Example: `1`	Optional

Examples

Example 1

{
  "@type": "Tag",
  "name": "VIP",
  "slug": "vip",
  "category": "segment",
  "description": "Very Important Person - top tier",
  "color": "#8B5CF6",
  "icon": "star",
  "isActive": true,
  "sortOrder": 1
}

Example 2

{
  "@type": "Tag",
  "name": "New",
  "slug": "new",
  "category": "status",
  "description": "Recently added",
  "color": "#10B981",
  "icon": "sparkles",
  "isActive": true,
  "sortOrder": 2
}

Example 3

{
  "@type": "Tag",
  "name": "Urgent",
  "slug": "urgent",
  "category": "priority",
  "description": "Requires immediate attention",
  "color": "#EF4444",
  "icon": "alert-circle",
  "isActive": true,
  "sortOrder": 10
}