Sign in
Email Template

Render email template

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.

post/api/v1/email_templates/{emailTemplateID}/render

Path parameters

emailTemplateIDinteger required

A unique integer value identifying this email template.

Request body

parent_emailstring uri

Link to parent email

document_liststring[]

List of document URLs to simulate sending of documents over email into Rossum

annotation_liststring[]

List of annotation URLs to use for rendering values for annotation.content placeholders

template_valuesobject

Values to fill in the email template

Example request

{
  "to": [
    {
      "email": "{{sender_email}}",
      "name": "John Doe"
    }
  ],
  "cc": [],
  "bcc": [],
  "parent_email": "https://example.rossum.app/api/v1/emails/1234",
  "document_list": [
    "https://example.rossum.app/api/v1/documents/2314"
  ],
  "annotation_list": [],
  "template_values": {}
}

Response

OK

subjectstring

Rendered email template's subject

messagestring

Rendered email template's message

Example response

{
  "to": [
    {
      "email": "satisfied.customer@rossum.ai"
    }
  ],
  "cc": [],
  "bcc": [],
  "subject": "My Email Template Subject: Rendered Parent Email Subject",
  "message": "<p>My Email Template Message from user@example.com</p>"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.