Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Email Templates

Render an email template

<small>Requires the sequences:operate scope (or a broader one that includes it).</small>

Renders an email template by substituting variables with actual contact data.

post/v3/email-templates/{id}/render

Path parameters

idinteger required

Email template ID to render

Request body

contactIdinteger required

ID of the contact whose data is used for variable substitution

sequenceIdinteger nullable

Optional sequence ID for sequence-specific variables

emailAccountIdinteger nullable

Optional email account ID for sender-specific variables

Example request

{
  "contactId": 500,
  "sequenceId": 12,
  "emailAccountId": 100
}

Response

Rendered template result

subjectstring nullable

Rendered email subject with variables replaced

bodystring nullable

Rendered email body with variables replaced

isSuccessboolean

Whether the rendering completed successfully

Example response

{
  "subject": "Hi John, quick follow-up",
  "body": "<p>Hi John,</p><p>Following up on our conversation.</p>",
  "isSuccess": true,
  "errors": []
}