Skip to main content

HTML content

Several API fields accept HTML content — descriptions, notes and similar rich text. The platform sanitizes every HTML field before storing it: only a small, safe subset of tags and attributes is preserved.

Allowed tags

The following tags are preserved:

TagsPurpose
h4, h5, h6headings
pparagraphs
brline breaks
ol, ul, liordered and unordered lists
strong, em, u, sbold, italic, underline, strikethrough
alinks

Allowed attributes

On links (a) the attributes href and target are preserved. All other attributes on any tag are removed.

What happens to everything else

Any tag not in the list — and any attribute that is not href or target on an a tag — is removed from the content. The tag itself is stripped while its text content is kept.

For required fields, aggressive stripping can result in an empty string — which the API rejects with a client error, exactly like any other missing required value. If a field must not be empty, make sure your content contains something that survives sanitization.

Design your content defensively

  • Use the allowed tags only; don’t rely on classes, styles or other attributes — they are dropped.
  • Send plain text when in doubt: plain text always survives sanitization.
  • Test a sample document once with the exact HTML you plan to send.