Skip to main content
POST
Preview a link template

Authorizations

Authorization
string
header
required

Partner API key: Authorization: Bearer vk_live_…. Use vk_test_… keys against the sandbox. See Authentication.

Headers

Idempotency-Key
string

Optional on every POST: 1-255 printable ASCII characters without spaces (a UUID is recommended). 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

Preview a Link Template.

template
string
required

1-2048 characters.

Maximum string length: 2048
voucherKind
enum<string>
required

code for a set-level template, link for a per-voucher link. Treat as an open set: new values may be added.

Available options:
code,
link

0-10 hosts.

Maximum array length: 10

Host.

0-3 custom schemes.

Maximum array length: 3

Scheme.

sample
object

Sample values.

Response

Success.

Single-object envelope around LinkTemplatePreview.

data
object
required

Preview of a Link Template.