Skip to main content

Usergroup 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 "usergroup".Required
usergroup_idStringThe ID of the user group to be mentioned.Required
styleObjectAn object of optional boolean properties that dictate style: bold, italic, strike, highlight, client_highlight, unlink, and underline.Optional

Example​

{
    "blocks": [
        {
            "type": "rich_text",
            "elements": [
                {
                    "type": "rich_text_section",
                    "elements": [
                        {
                            "type": "usergroup",
                            "usergroup_id": "G123ABC456"
                        }
                    ]
                }
            ]
        }
    ]
}

View in Block Kit Builder