Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# Rich Text

Select parameters currently accept values with rich text, which can be formatting using a subset of standard HTML tags and CSS styles. The formatting of the text does not need to be uniform throughout. Different parts of the content can be formatted differently.

> **Note:**
> For strings identified by double quotations, any internal double quotations within the string need to be escaped using `\`. This is not necessary for strings identified by single quotes that are not passed as a JSON object.
>
> Example:
> - `"This is red text"`
> - `'This is red text'`

## Supported HTML tags:
- `` (Paragraph)
- `<h1>`, `<h2>`, `<h3>`, `<h4>`, `<h5>`, and `<h6>` (Headings)
- `<a>` (Anchor/link)
- `` (Inline)
- `` (Bold)
- `` (Italicize)
- `` (Underline)
- `<ul>`, `<ol>`, and `<li>` (Lists)
- ` ` (Line break)


## Inline styling: 
- `style`
- `dir`

### Supported `style` properties:
- `font-face`
- `font-size`
- `font-weight`
- `font-style`
- `text-decoration`
- `color`
- `background-color`
- `text-align`
- `margin-left`
- `text-shadow`
- `line-height`
- `letter-spacing`


## Rich text formatting examples:

```javascript
"This is bolded text"

"This is underlined text" 

"This is red text"

"This is black text with a red background"

"<a href=\"http://www.google.com\" target=\"_blank\">This is a link</a>" 
```

```
"<ul>
 <li>This is a bullet</li>
 <li>This is a second bullet</li>
</ul>"
``` 

```
"<ol>
 <li>This is a numbered list item</li>
 <li>This is a second numbered list item</li>
</ol>"
```

Rich Text

Supported HTML tags:

Inline styling:

Supported style properties:

Rich text formatting examples:

Supported `style` properties: