Skip to main content
POST
Add a custom domain

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

New custom domain.

hostname
string<hostname>
required

Subdomain you own (at least three labels).

purpose
enum<string>
required

Always redemption-landing.

Available options:
redemption-landing

Response

Created

Single-object envelope around a CustomDomain.

data
object
required

A custom host name for your Redemption Link landing pages.