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:

  • "<p><span style=\"color:#cb2026\">This is red text</span></p>"
  • '<p><span style="color:#cb2026;">This is red text</span></p>'

Supported HTML tags:

  • <p> (Paragraph)
  • <h1>, <h2>, <h3>, <h4>, <h5>, and <h6> (Headings)
  • <a> (Anchor/link)
  • <span> (Inline)
  • <strong> (Bold)
  • <em> (Italicize)
  • <u> (Underline)
  • <ul>, <ol>, and <li> (Lists)
  • <br> (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:

Copy
1
"<p><strong>This is bolded text</strong></p>"
2


3
"<p><u>This is underlined text</u></p>"  
4


5
"<p><span style=\"color:#cb2026\">This is red text</span></p>"
6


7
"<p><span style=\"color:#000000;\"><span style=\"background-color:#ce5028;\">This is black text with a red background</span></span></p>"
8


9
"<p><a href=\"http://www.google.com\" target=\"_blank\">This is a link</a></p>"
Copy
1
"<ul>
2
   <li>This is a bullet</li>
3
   <li>This is a second bullet</li>
4
</ul>"
Copy
1
"<ol>
2
   <li>This is a numbered list item</li>
3
   <li>This is a second numbered list item</li>
4
</ol>"
Was this helpful?
Yes
No