Skip to main content

​
Tag

Represents a tag used to categorize and organize mentions within an alert.
​
id
string
required
Unique identifier for the tag
​
name
string
required
Tag name or label
​
color
string
Hex color code for visual representation (e.g., “#3B82F6”)

​
Example

{
  "id": "tag_1234567890",
  "name": "Customer Feedback",
  "color": "#10B981"
}

​
Request Models

​
CreateTagRequest

Used when creating a new tag.
​
name
string
required
Tag name or label
​
color
string
Hex color code (e.g., “#3B82F6”)

​
UpdateTagRequest

Used when updating an existing tag. All fields are optional.
​
name
string
Updated tag name
​
color
string
Updated hex color code

​
TagsResponse

Response containing a list of tags.
​
tags
array
required
List of Tag objects

​
Example

{
  "tags": [
    {
      "id": "tag_1",
      "name": "Customer Feedback",
      "color": "#10B981"
    },
    {
      "id": "tag_2",
      "name": "Bug Reports",
      "color": "#EF4444"
    },
    {
      "id": "tag_3",
      "name": "Feature Requests",
      "color": "#3B82F6"
    }
  ]
}

Build docs developers (and LLMs) love

Get started for freeTalk to us