Skip to main content
POST
Render an email template

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Get your API key from the Reply dashboard: Settings → API Key.

Path Parameters

id
integer
required

Email template ID to render

Body

application/json

Request body for rendering an email template with variable substitution.

contactId
integer
required

ID of the contact whose data is used for variable substitution

Required range: x >= 1
sequenceId
integer | null

Optional sequence ID for sequence-specific variables

emailAccountId
integer<int64> | null

Optional email account ID for sender-specific variables

Response

Rendered template result

Result of rendering an email template with variable substitution.

subject
string | null

Rendered email subject with variables replaced

body
string | null

Rendered email body with variables replaced

isSuccess
boolean

Whether the rendering completed successfully

errors
RenderError · object[]

List of rendering errors (e.g., unresolved variables)