Skip to main content
POST
Render a template proof with a sample recipient

Authorizations

Authorization
string
header
required

Dairo API key, e.g. dairo_test_... or dairo_live_...

Path Parameters

id
string
required

Body

application/json

All fields optional; the proof renders with a sample recipient and, by default, left address placement.

templateData
object

Values that fill the template's {{placeholders}} for the preview.

addressPlacement
enum<string>
Available options:
left,
right

Response

Success

object
enum<string>
required
Available options:
letter_template_preview
templateId
string
required
addressPlacement
enum<string>
required
Available options:
left,
right
pdfBase64
string
required

The composited proof PDF, base64-encoded.