Skip to main content
PATCH
Update 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.

Path Parameters

redemptionEntityId
integer<uint64>
required

Id of the redemption entity. Unsigned 64-bit integer (ids and large counters). May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Body

application/json

JSON Merge Patch. email, status and createdVia are not writable.

refId
string | null

New refId; null clears.

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

1-120 characters; null clears.

Maximum string length: 120
metadata
object | null

Replaced as a whole; null clears.

Example:

Response

OK

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.