Rich text list element
A bulleted or numbered list. Each item is a rich text section.
| Available in | Messages, Modals, Home tab |
| Used in | Rich text block |
To nest a list, follow it with another rich_text_list with a higher indent. To continue the numbering after a nested list, give the next ordered list an offset.
Fields
Section titled “Fields”| Field | Type | Description | Required? |
|---|---|---|---|
type |
String | The type of sub-element; in this case, rich_text_list. |
Required |
style |
String | Either bullet or ordered, the latter meaning a numbered list. |
Required |
elements |
Array of Rich text section element | The list items: an array of rich_text_section objects, each holding rich text elements. |
Required |
indent |
Number | The indent level of the list, for nested lists. | Optional |
offset |
Number | The number to offset the first item of an ordered list by. With offset of 4, the list starts at 5. |
Optional |
border |
Number | Turns a border on (1) or off (0). | Optional |
Examples
Section titled “Examples”A bulleted list
Section titled “A bulleted list”
{ "blocks": [ { "type": "rich_text", "elements": [ { "type": "rich_text_section", "elements": [ { "type": "text", "text": "Before Thursday's renewal call:" } ] }, { "type": "rich_text_list", "style": "bullet", "elements": [ { "type": "rich_text_section", "elements": [ { "type": "text", "text": "Confirm seat count with the customer" } ] }, { "type": "rich_text_section", "elements": [ { "type": "text", "text": "Prepare the 24-month pricing option" } ] }, { "type": "rich_text_section", "elements": [ { "type": "text", "text": "Share the agenda with " }, { "type": "user", "user_id": "3f6c2a1e-8b4d-4c7a-9e21-5d0b7f9a1c34" } ] } ] } ] } ]}A numbered list with a nested list
Section titled “A numbered list with a nested list”
{ "blocks": [ { "type": "rich_text", "elements": [ { "type": "rich_text_list", "style": "ordered", "elements": [ { "type": "rich_text_section", "elements": [ { "type": "text", "text": "Import the contact list" } ] }, { "type": "rich_text_section", "elements": [ { "type": "text", "text": "Map the custom fields" } ] } ] }, { "type": "rich_text_list", "style": "bullet", "indent": 1, "elements": [ { "type": "rich_text_section", "elements": [ { "type": "text", "text": "Industry" } ] }, { "type": "rich_text_section", "elements": [ { "type": "text", "text": "Account tier" } ] } ] }, { "type": "rich_text_list", "style": "ordered", "offset": 2, "elements": [ { "type": "rich_text_section", "elements": [ { "type": "text", "text": "Run the duplicate check" } ] } ] } ] } ]}