> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/developers/api-documentation/templates/render-transaction-template-preview.md).

# Render transaction template preview

Render transaction template preview

TEMPLATE reaches every template. SERVICE\_CONFIG reaches the templates of a service template type only — a type the platform's own catalog on the `/metadata/templates` endpoint does not list, which is what templateOrigin SERVICE lists, the seven types the service module sends under fixed names and every other type the tenant has created alike — because a service message text is service configuration. A caller holding SERVICE\_CONFIG and not TEMPLATE is refused with a 403 on a template of a platform type, and nothing is rendered. A tenant-wide ADMIN grant counts as every permission.

Required permissions: TEMPLATE, SERVICE\_CONFIG

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Notifications","description":"Notifications"},{"name":"Templates","description":"Templates"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"authToken":[]},{"accessToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}}},"paths":{"/tenants/{tenantUid}/templates/{templateUid}/notifications-preview":{"post":{"summary":"Render transaction template preview","tags":["Templates","Notifications"],"responses":{"200":{"description":"OK","content":{"text/html":{"schema":{"type":"string","description":"The rendered template as an HTML document, its variables filled with sample values. For a service template type the text samples are in the language the template is written in, whatever the signed-in user's language, and the document shows the message the way it is sent: the subject, when the template has one, rendered with the same sample values and labelled in the template's language above the body; an e-mail body rendered as HTML, the values written into it escaped; an SMS body as plain text with its line breaks kept."}}}},"400":{"description":"Bad Request"}},"operationId":"render-tenant-template-notifications-preview","description":"Render transaction template preview\n\nTEMPLATE reaches every template. SERVICE_CONFIG reaches the templates of a service template type only — a type the platform's own catalog on the `/metadata/templates` endpoint does not list, which is what templateOrigin SERVICE lists, the seven types the service module sends under fixed names and every other type the tenant has created alike — because a service message text is service configuration. A caller holding SERVICE_CONFIG and not TEMPLATE is refused with a 403 on a template of a platform type, and nothing is rendered. A tenant-wide ADMIN grant counts as every permission.\n\nRequired permissions: TEMPLATE, SERVICE_CONFIG"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flowretail.com/docs/developers/api-documentation/templates/render-transaction-template-preview.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
