Skip to main content
PATCH
Update a redemption link

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

Id of the Redemption Link. 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. mode, redemptionEntityId, requireEmailOtp and token are immutable.

name
string | null

1-120 characters; null clears.

Maximum string length: 120
allowedProviderIds
integer<uint64>[]

Allowed providers (added ids are checked against the catalog).

Maximum array length: 50

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
allowedVoucherSetIds
integer<uint64>[]

Allowed voucher sets (added ids are checked against the catalog).

Maximum array length: 200

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
maxRedemptions
integer<uint64>

At least redemptionCount for non-OTP links; equal to it exhausts the link.

Required range: 1 <= x <= 18446744073709552000
maxTotalRedemptions
integer<uint64>

email-otp links only; at least redemptionCount.

Required range: 1 <= x <= 18446744073709552000
metadata
object | null

Applies to future redemptions only.

Example:
expiresAt
string<date-time> | null

Future time, or null.

Example:

"2026-11-01T00:00:00Z"

customDomainId
integer<uint64> | null

One of your active custom domains.

Required range: 0 <= x <= 18446744073709552000
defaultLocale
enum<string> | null

de or en.

Available options:
de,
en

Response

OK

Single-object envelope around a RedemptionLink.

data
object
required

A shareable link to an AllRide-hosted landing page where an end customer redeems.