Skip to main content

Tag element

This is a rich text element, compatible only with the rich_text block. It must be used within the rich_text_list, rich_text_quote, or rich_text_section block element within the rich_text block's elements array.

Fields

FieldTypeDescriptionRequired?
typeStringThe type of object; in this case, "tag".Required
textStringThe text displayed in the tag.Required
colorStringThe color of the tag. The options for this value are: "gray", "brown", "purple", "indigo", "blue", "green", "yellow", "orange", "red".Optional
styleObjectAn object of optional boolean properties that dictate style: bold, italic, strike, highlight, client_highlight, underline, and unlink.Optional

Example

{
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "tag",
"text": "In progress"
}
]
}
]
}
]
}

View in Block Kit Builder