Understand how to work with and preserve rich text formatting (Markdown) in supported standard and custom fields via the Hyperproof API. Learn which formatting options are supported, review example requests, and discover limitations with documentation insights.
Hyperproof offers rich text fields, such as descriptions or notes on controls, tasks, requests, risks, multi-line custom text fields, etc., that support Markdown and WYSIWYG editing. You can send formatted content via the API using Markdown references.
Hyperproof supports the following formatting options:
- Bold, italic, bold & italic
- Strikethrough (text)
- Headings
- Bullet and numbered lists
- Inline code and code blocks
- Links and emojis
You can include Markdown directly in your PATCH or POST payloads. Here’s an enhanced PATCH example:
curl --location --request PATCH 'https://api.hyperproof.app/v1/controls/your_control_guid' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xyz' \
--data '{
"customFields": [
{
"fieldId": "your_custom_field_guid",
"fieldName": "yourcustomfieldname",
"textValue": "- **Bold item**\n- *Italic item*\n- ~~Strikethrough~~\n\n### Heading\n[Link text](https://example.com)\n\n`Inline code`"
}
]
}'
- Use
\nfor new lines - Markdown is automatically interpreted in supported fields
- No field-type flag is needed: Support is inferred at the UI level
- Security: Formatting in pasted text (e.g., directly from Word/Excel) is stripped of formatting; you must enter formatting manually or via Markdown
- Supported fields: Descriptions, notes, multiline text custom fields in controls, tasks, requests, risks, requirements, etc.
- Unsupported features: Links containing
@in domain names (e.g.,http://hyperproof.io@xyz.com) are blocked. - Rendering consistency: Most fields render markdown correctly; unsupported fields may display raw syntax.