---
title: "Render email template"
method: POST
path: "/api/v1/email_templates/{emailTemplateID}/render"
tags: ["Email Template"]
---

# Render email template

`POST /api/v1/email_templates/{emailTemplateID}/render`

The rendered email template can be requested via the render endpoint. 

Inside the `to`, `cc` and `bcc` attributes template variables can be used instead of the email field of the email address object.

## Path parameters

- `emailTemplateID` integer, required

## Request body

- RenderRequest
  - `to` EmailAddressTemplate[] — List that contains information about recipients to be rendered. The total number of recipients (to, cc and bcc together) cannot exceed 40.
    - `email` string, required — Email address.
    - `name` string, nullable — Name of the email recipient.
  - `cc` EmailAddressTemplate[] — List that contains information about recipients of carbon copy to be rendered. The total number of recipients (to, cc and bcc together) cannot exceed 40.
    - `email` string, required — Email address.
    - `name` string, nullable — Name of the email recipient.
  - `bcc` EmailAddressTemplate[] — List that contains information about recipients of blind carbon copy to be rendered. The total number of recipients (to, cc and bcc together) cannot exceed 40.
    - `email` string, required — Email address.
    - `name` string, nullable — Name of the email recipient.
  - `parent_email` string, uri — Link to parent email
  - `document_list` string[] — List of document URLs to simulate sending of documents over email into Rossum
  - `annotation_list` string[] — List of annotation URLs to use for rendering values for annotation.content placeholders
  - `template_values` object — Values to fill in the email template

## Response `200`

OK

- RenderResponse
  - `to` EmailAddress[] — List that contains rendered information about recipients
    - `email` string, email, required — Email address.
    - `name` string, nullable — Name of the email recipient.
  - `cc` EmailAddress[] — List that contains rendered information about recipients of carbon copy
    - `email` string, email, required — Email address.
    - `name` string, nullable — Name of the email recipient.
  - `bcc` EmailAddress[] — List that contains rendered information about recipients of blind carbon copy
    - `email` string, email, required — Email address.
    - `name` string, nullable — Name of the email recipient.
  - `subject` string — Rendered email template's subject
  - `message` string — Rendered email template's message

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict
- `413` — Payload too large (especially for files uploaded).
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

[API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)
