, optional, keys: pattern `^[A-Za-z0-9_-]{1,64}$`) — Sample data for `{{ event.properties.* }}` tags and repeat lists: what a transactional send's `data` or a journey's event would carry. Without it, a repeat shows once with its item tags as written.
## Returns
Returns `200 OK` with a `TemplateRender` in `data`. It can also return `409 Conflict`, `413 Payload Too Large` or `415 Unsupported Media Type`; see the statuses below. Otherwise returns an error; [Errors](https://kirora.io/docs/api/reference/errors) lists every code and which to retry.
- `html` (string, required) — The rendered HTML.
- `text` (string, required) — The rendered plain-text version.
- `subject` (string, optional) — The subject with merge tags filled in.
- `sizeBytes` (integer, required, min 0) — Size of the HTML in bytes.
- `warnings` (object[], required) — Problems that do not stop rendering, such as a size that risks clipping.
- `code` (string, required) — A stable code for the kind of problem.
- `title` (string, required) — A short summary.
- `detail` (string, required) — What is wrong and how to fix it.
Statuses:
- `200 OK`: The rendered HTML, plain text, size and warnings.
- `409 Conflict`: The request conflicts with current state — a duplicate unique value, or a resource whose status does not allow this operation.
- `413 Payload Too Large`: The body is larger than this operation accepts (`PAYLOAD_TOO_LARGE`).
- `415 Unsupported Media Type`: The body is not JSON, or not the upload the operation takes (`UNSUPPORTED_MEDIA_TYPE`).
## Example: Render a design for one contact without saving it
```bash
curl -X POST https://api.kirora.io/v1/templates/render \
-H "Authorization: Bearer $KIRORA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"blocks": [
{
"id": "title",
"type": "heading",
"text": "Welcome to Acme Shop",
"size": "28px"
},
{
"id": "intro",
"type": "text",
"text": "Hi {{ contact.firstName }}, thanks for joining. Your first order ships free."
},
{
"id": "shop",
"type": "button",
"text": "Start shopping",
"href": "https://acme-shop.com"
},
{
"id": "store-footer",
"type": "shared",
"sharedBlockId": "0192f3d1-3c4d-7e5f-8a61-7c8d9e0f1a2b"
},
{
"id": "footer",
"type": "footer",
"text": "{{ org.name }}\n{{ org.address }}",
"locked": true
}
],
"theme": {
"bodyFontFamily": "Arial, sans-serif",
"headingFontFamily": "Georgia, serif",
"cardBackgroundColor": "#ffffff",
"canvasBackgroundColor": "#f4f1ec",
"textColor": "#1f2933",
"accentColor": "#b4461f",
"linkColor": "#b4461f",
"cardWidth": "600px",
"cardBorderRadius": "6px",
"buttonStyle": "solid"
},
"contact": {
"contactId": "0192f3a1-7c2e-7d4b-9a10-3e5f6a7b8c9d"
},
"subject": "Welcome to Acme Shop"
}'
```
Response `200`:
```json
{
"data": {
"html": "Welcome to Acme Shop
Hi Amaka, thanks for joining. Your first order ships free.
",
"text": "Welcome to Acme Shop\n\nHi Amaka, thanks for joining. Your first order ships free.\n\nStart shopping: https://acme-shop.com",
"subject": "Welcome to Acme Shop",
"sizeBytes": 2048,
"warnings": []
}
}
```
## Example: Preview HTML in the code editor: what saving keeps, and what it removes
```bash
curl -X POST https://api.kirora.io/v1/templates/render \
-H "Authorization: Bearer $KIRORA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"kind": "html",
"html": "The Acme Shop monthly
Hi {{ contact.firstName | default: \"there\" }}, here is what is new.
Unsubscribe
"
}'
```
Response `200`:
```json
{
"data": {
"html": "The Acme Shop monthly
Hi there, here is what is new.
Unsubscribe
",
"text": "The Acme Shop monthly\n\nHi there, here is what is new.\n\nUnsubscribe ({{unsubscribe_url}})",
"sizeBytes": 255,
"warnings": [
{
"code": "HTML_REMOVED",
"title": "Some code is removed",
"detail": "Saving removes scripts. Email apps do not run them, so the email looks the same in an inbox."
}
]
}
}
```