Skip to main content
POST
Create a redemption entity

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

All fields optional; {} creates an anonymous entity. email is not writable.

refId
string | null

Your opaque reference; ^[A-Za-z0-9._:@/+=-]{1,128}$.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:@/+=-]{1,128}$
displayName
string | null

1-120 characters; an empty string is stored as null.

Maximum string length: 120
metadata
object | null

Your own JSON object, stored and returned as sent (key order not preserved); at most 16 KiB, depth 5 and 100 keys per object. Never put personal data here.

Example:

Response

Created

Single-object envelope around a RedemptionEntity.

data
object
required

Your record of who or what redeems. An erased entity returns refId, displayName, email and metadata as null.