Skip to main content
POST
Render an unsaved template preview

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Headers

Idempotency-Key
string

Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: the same key with the same request replays the stored response for 24 hours. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Body

application/json

An unsaved template to render.

purpose
enum<string>
required

Template purpose.

Available options:
redemption-link-otp
subject
object
required

Subject per locale.

Example:
htmlBody
object
required

HTML per locale.

textBody
object | null

Text per locale.

locale
enum<string> | null

Locale to render.

Available options:
de,
en

Response

OK

Single-object envelope around a EmailTemplatePreview.

data
object
required

A template rendered with sample data (otpCode 123456, expiresInMinutes 10).